Class ItemActionSheet

Internal_activeEdits

alignments

Static_warnedAppV1

Static InternalEDIT_TRACKING

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

  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: any): boolean

  Foundry defaults to isGM check.

  Parameters

  • selector: any

  Returns boolean

_canDragStart

• _canDragStart(selector: any): boolean

  Foundry defaults to isGM check.

  Parameters

  • selector: any

  Returns boolean

_createDocumentIdLink

• _createDocumentIdLink(html: JQueryStatic): void
  Internal

  Copy of DocumentSheet._createDocumentIdLink

  Parameters

  • html: JQueryStatic

    Synced with Foundry v12.331

  Returns void

_onAlignmentChecked

• _onAlignmentChecked(event: any): Promise<void>

  Parameters

  • event: any

  Returns Promise<void>

_onAttackControl

• _onAttackControl(event: any): Promise<void>

  Parameters

  • event: any

  Returns Promise<void>

_onClickDamageType

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

  Parameters

  • event: Event

  Returns Promise<any>

_onConditionalControl

• _onConditionalControl(event: any): Promise<any>

  Parameters

  • event: any

  Returns Promise<any>

_onDragStart

• _onDragStart(event: any): void

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

  Parameters

  • event: any

    The originating DragEvent

  Returns void

_onDrop

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

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

  Parameters

  • event: any

    The originating DragEvent

  Returns Promise<void>

_onMaterialSelector

• _onMaterialSelector(event: any): void

  Parameters

  • event: any

  Returns void

_onNoteEntryControl

• _onNoteEntryControl(event: any): Promise<void>

  Parameters

  • event: any

  Returns Promise<void>

_onTextAreaDrop

• _onTextAreaDrop(event: any): Promise<undefined | Partial<AnyObject>>

  Parameters

  • event: any

  Returns Promise<undefined | Partial<AnyObject>>

_prepareAlignments

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

  Parameters

  • alignments: {} = {}

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

_render

• _render(force: any, options?: {}): Promise<void>

  Parameters

  • force: any
  • options: {} = {}

  Returns Promise<void>

_renderOuter

• _renderOuter(): Promise<JQuery<HTMLElement>>

  Used to call _createDocumentIdLink

  Returns Promise<JQuery<HTMLElement>>

_updateObject

• _updateObject(event: any, formData: any): 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: JQuery<HTMLElement>): void

  Parameters

  • html: JQuery<HTMLElement>

  Returns void

close

• close(options?: {}): Promise<void>

  Parameters

  • options: {} = {}

    (default: {})

  Returns Promise<void>

getData

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

  Returns Promise<
      {
          action: ItemAction;
          actor: ActorPF;
          choices: { measureTemplateTypes: Record<string, string> };
          config: config;
          cssClass: string;
          damageTypes: { [id: string]: object };
          data: any;
          editable: boolean;
          fields: any;
          img: undefined | string;
          item: ItemPF;
          rollData: object;
          tag: any;
          user: undefined | null | _Override<User, {}>;
      },
  >

render

• render(...args: any[]): ItemActionSheet

  Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls

  Parameters

  • ...args: any[]

  Returns ItemActionSheet

  The rendered Application instance

  Remarks

  Some subclasses return other results.