Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class ItemScriptCall

    Script Call

    Hierarchy

    • any
      • ItemScriptCall
    Index

    Constructors

    constructor

    Properties

    _id? category constructor hidden? img? name? type value metadata

    Accessors

    documentName hide id isMacro uuid documentName

    Methods

    delete edit execute getDelegate prepareData update create defineSchema migrateData pruneData

    Constructors

    Properties

    Optional_id

    _id?: string

    Internal ID.

    category: string
    constructor: typeof ItemScriptCall
    hidden?: boolean

    Hidden from normal user, even document owner.

    img?: any

    Script image. If type is macro, this is overwritten by the macro image.

    name?: {}

    Script name. If type is macro, this is overwritten by the macro name.

    type: "script" | "macro"
    value: string

    If type is script, this is the script body. If type is macro, this is the UUID to the macro.

    metadata: Readonly<{ label: "Script Call"; name: "Script" }> = ...

    Metadata mimicking Foundry documents

    Required by pf1.applications.ScriptEditor

    Accessors

    • get documentName(): string

      Returns string

    • get hide(): boolean

      Returns boolean

    • get id(): string

      Returns string

    • get isMacro(): boolean

      Returns boolean

    • get uuid(): string

      Retrieve UUID

      Relies on Item#getEmbeddedDocument() override to function with fromUuid() and similar functions.

      Returns string

    • get documentName(): "Script"

      Returns "Script"

    Methods

    • Delete this script call

      Parameters

      • options: object = {}

        Context options to pass to the update call

      Returns Promise<any>

    • Parameters

      • __namedParameters: { editable?: boolean } = {}

      Returns Promise<any>

    • Executes the script.

      Parameters

      • shared: object

        An object passed between script calls, and which is passed back as a result of ItemPF.executeScriptCalls.

      • extraParams: object = {}

        A dictionary containing extra parameters to pass on to the call.

      Returns Promise<any>

      • Script return value if any

    • Get macro delegate for executing this script call with.

      Returns Promise<Macro<"script" | "chat">>

      • Actual macro or its delegate

    • Returns void

    • Parameters

      • updateData: any
      • options: {} = {}

      Returns Promise<any>

    • Creates a script call.

      Parameters

      • data: object[]

        Data to initialize the script call(s) with.

      • context: { parent?: ItemPF }

        An object containing context information.

        • Optionalparent?: ItemPF

          The parent entity to create the script call within.

      Returns Promise<ItemScriptCall[]>

      • The resulting script calls, or an empty array if nothing was created.

    • Returns {
          _id: StringField<
              { blank: false; initial: () => string; readonly: true; required: true },
              AssignmentType<
                  {
                      blank: false;
                      initial: () => string;
                      readonly: true;
                      required: true;
                  },
              >,
              string,
              string,
          >;
          category: StringField<
              { required: false },
              AssignmentType<{ required: false }>,
              InitializedType<{ required: false }>,
              InitializedType<{ required: false }>,
          >;
          hidden: BooleanField<
              { initiall: undefined; required: boolean },
              AssignmentType<
                  SimpleMerge<
                      { initiall: undefined; required: boolean },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initiall: undefined; required: boolean },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initiall: undefined; required: boolean },
                      DefaultOptions,
                  >,
              >,
          >;
          img: FilePathField<
              {
                  blank: false;
                  categories: "IMAGE"[];
                  initiall: undefined;
                  required: boolean;
              },
              AssignmentType<
                  {
                      blank: false;
                      categories: "IMAGE"[];
                      initiall: undefined;
                      required: boolean;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      categories: "IMAGE"[];
                      initiall: undefined;
                      required: boolean;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      categories: "IMAGE"[];
                      initiall: undefined;
                      required: boolean;
                  },
              >,
          >;
          name: StringField<
              { initial: () => any; required: true },
              AssignmentType<{ initial: () => any; required: true }>,
              string,
              string,
          >;
          priority: NumberField<
              { initiall: undefined; integer: true; required: boolean },
              AssignmentType<{ initiall: undefined; integer: true; required: boolean }>,
              InitializedType<{ initiall: undefined; integer: true; required: boolean }>,
              InitializedType<{ initiall: undefined; integer: true; required: boolean }>,
          >;
          type: StringField<
              {
                  blank: false;
                  choices: readonly ["script", "macro"];
                  initiall: undefined;
                  nullable: false;
                  required: boolean;
              },
              AssignmentType<
                  {
                      blank: false;
                      choices: readonly ["script", "macro"];
                      initiall: undefined;
                      nullable: false;
                      required: boolean;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: readonly ["script", "macro"];
                      initiall: undefined;
                      nullable: false;
                      required: boolean;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: readonly ["script", "macro"];
                      initiall: undefined;
                      nullable: false;
                      required: boolean;
                  },
              >,
          >;
          value: StringField<
              { blank: true; nullable: false; required: true },
              AssignmentType<{ blank: true; nullable: false; required: true }>,
              string,
              string,
          >;
      }

    • Parameters

      • source: any

      Returns any

    • Parameters

      • source: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods