Class ItemScriptCall

constructor

• new ItemScriptCall(data, parent): ItemScriptCall

• Parameters

  • data: any

  • parent: any

  Returns ItemScriptCall

data

parent

category

• get category(): string

• Returns string

hidden

• get hidden(): boolean

• Returns boolean

hide

• get hide(): boolean

• Returns boolean

id

• get id(): string

• Returns string

img

• get img(): string

• Returns string

name

• get name(): string

• Returns string

type

• get type(): string

• Returns string

value

• get value(): string

• Returns string

Static defaultData

• get defaultData(): {
      _id: string;
      category: string;
      hidden: boolean;
      img: string;
      name: string;
      type: string;
      value: string;
  }

• Returns {
      _id: string;
      category: string;
      hidden: boolean;
      img: string;
      name: string;
      type: string;
      value: string;
  }

  • _id: string

  • category: string

  • hidden: boolean

  • img: string

  • name: string

  • type: string

  • value: string

edit

• edit(__namedParameters?): Promise<any>

• Parameters

  • __namedParameters: {
        editable: undefined | boolean;
    } = {}

    • editable: undefined | boolean

  Returns Promise<any>

execute

• execute(shared, extraParams?): 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: {} = {}

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

  Returns any

  • Script return value if any

getDelegate

• getDelegate(): Macro

• Get macro delegate for executing this script call with.

  Returns Macro

update

• update(data, options?): Promise<any>

• Parameters

  • data: any

  • options: {} = {}

  Returns Promise<any>

Static create

• create(data, context): Promise<any[]>

• Creates a script call.

  Parameters

  • data: object[]

    Data to initialize the script call(s) with.

  • context: {
        parent: undefined | ItemPF;
    }

    An object containing context information.

    • parent: undefined | ItemPF

      The parent entity to create the script call within.

  Returns Promise<any[]>

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