Class ItemActionSheet

constructor

• new ItemActionSheet(...args): ItemActionSheet

• Parameters

  • Rest...args: any[]

  Returns ItemActionSheet

alignments

action

• get action(): ItemAction

• Returns ItemAction

actor

• get actor(): ActorPF

• Returns ActorPF

id

• get id(): string

• Return the CSS application ID which uniquely references this UI element

  Returns string

isEditable

• get isEditable(): boolean

• Copy from core DocumentSheet#isEditable

  Returns boolean

item

• get item(): ItemPF

• Returns ItemPF

title

• get title(): string

• An Application window should define its own title definition logic which may be dynamic depending on its data

  Returns string

StaticdefaultOptions

• get defaultOptions(): {
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      height: number;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: string;
      width: number;
  }

• Assign the default options which are supported by the entity edit sheet.

  Returns {
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      height: number;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: string;
      width: number;
  }

  The default options for this FormApplication class

  • classes: string[]

  • closeOnSubmit: boolean

  • dragDrop: {
        dragSelector: string;
        dropSelector: string;
    }[]

  • height: number

  • resizable: boolean

  • scrollY: string[]

  • submitOnChange: boolean

  • submitOnClose: boolean

  • tabs: {
        contentSelector: string;
        group: string;
        initial: string;
        navSelector: string;
    }[]

  • template: string

  • width: number

  See

  Application.defaultOptions

  Default Value

  foundry.utils.mergeObject(super.defaultOptions, {
    classes: ["form"],
    closeOnSubmit: true,
    editable: true,
    sheetConfig: false,
    submitOnChange: false,
    submitOnClose: false
  });
  Copy

_canDragDrop

• _canDragDrop(selector): boolean

• Foundry defauts to isGM check.

  Parameters

  • selector: any

  Returns boolean

_canDragStart

• _canDragStart(selector): boolean

• Foundry defauts to isGM check.

  Parameters

  • selector: any

  Returns boolean

_onAlignmentChecked

• _onAlignmentChecked(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onAttackControl

• _onAttackControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onClickDamageType

• _onClickDamageType(event): Promise<any>
• Internal

  Parameters

  • event: Event

  Returns Promise<any>

_onConditionalControl

• _onConditionalControl(event): Promise<any>

• Parameters

  • event: any

  Returns Promise<any>

_onDragStart

• _onDragStart(event): void
• Internal

  Callback actions which occur at the beginning of a drag start workflow.

  Parameters

  • event: any

    The originating DragEvent

  Returns void

_onDrop

• _onDrop(event): Promise<void>
• Internal

  Callback actions which occur when a dragged element is dropped on a target.

  Parameters

  • event: any

    The originating DragEvent

  Returns Promise<void>

_onNoteEntryControl

• _onNoteEntryControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onTextAreaDrop

• _onTextAreaDrop(event): Promise<undefined | Partial<Record<string, unknown>>>

• Parameters

  • event: any

  Returns Promise<undefined | Partial<Record<string, unknown>>>

_prepareAlignments

• _prepareAlignments(alignments?): {
      choices: {};
      values: {};
  }

• Parameters

  • alignments: {} = {}

  Returns {
      choices: {};
      values: {};
  }

  • choices: {}

  • values: {}

_prepareMaterialsAndAddons

• _prepareMaterialsAndAddons(): {
      addons: any[];
      materials: {};
  }

• Returns {
      addons: any[];
      materials: {};
  }

  • addons: any[]

  • materials: {}

_updateObject

• _updateObject(event, formData): Promise<void>

• This method is called upon form submission after form data is validated

  Parameters

  • event: any

    The initial triggering submission event
  • formData: any

    The object of validated form data with which to update the object

  Returns Promise<void>

  A Promise which resolves once the update operation has completed

activateListeners

• activateListeners(html): void

• Parameters

  • html: any

  Returns void

close

• close(options?): Promise<void>

• Parameters

  • options: {} = {}

    (default: {})

  Returns Promise<void>

getData

• getData(): Promise<{
      action: ItemAction;
      actor: ActorPF;
      config: config;
      cssClass: string;
      damageTypes: {
          [id: string]: object;
      };
      data: any;
      editable: boolean;
      img: any;
      item: ItemPF;
      rollData: object;
      tag: any;
      user: null | StoredDocument<User>;
  }>

• Returns Promise<{
      action: ItemAction;
      actor: ActorPF;
      config: config;
      cssClass: string;
      damageTypes: {
          [id: string]: object;
      };
      data: any;
      editable: boolean;
      img: any;
      item: ItemPF;
      rollData: object;
      tag: any;
      user: null | StoredDocument<User>;
  }>