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

    Class ActorSelector

    A specialized form application for selecting an Actor from a list of available choices

    Used for example with gift item.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    DEFAULT_OPTIONS PARTS

    Accessors

    documents promise selected

    Methods

    _initializeApplicationOptions _onClose _onRender _prepareContext wait

    Constructors

    Properties

    DEFAULT_OPTIONS: {
        actors: undefined;
        ownership: undefined;
        selected: null;
        window: { icon: string; title: string };
    } = ...
    PARTS: {
        footer: { template: string };
        form: { scrollable: string[]; template: string };
    } = ...

    Accessors

    • get documents(): Actor<"base" | ModuleSubType>[]

      Returns Actor<"base" | ModuleSubType>[]

    • get promise(): Promise<any>

      Returns Promise<any>

    • get selected(): string

      Returns string

    Methods

    _initializeApplicationOptions

    • _initializeApplicationOptions(options: any): any

      Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.

      • Array-based options are concatenated
      • Inner objects are merged
      • Otherwise, properties in the subclass replace those defined by a parent

      Parameters

      • options: any

        Options provided directly to the constructor

      Returns any

      Configured options for the application instance

    _onClose

    • _onClose(options: any): void

      Actions performed after closing the Application. Post-close steps are not awaited by the close process.

      Parameters

      • options: any

        Provided render options

      Returns void

    Protected_onRender

    • _onRender(context: ApplicationRenderContext, options: RenderOptions): void
      Protected

      Attach event listeners to the rendered application form.

      Parameters

      • context: ApplicationRenderContext

        Prepared context data

      • options: RenderOptions

        Provided render options

      Returns void

    _prepareContext

    • _prepareContext(): Promise<
          {
              buttons: { label: string; type: string }[];
              document: any;
              empty: { document: { id: string; img: string; name: any }; include: any };
              searchTerm: any;
              sections: DocumentSelectorSection[];
              selected: string;
              showSectionHeaders: boolean;
          },
      >
      Internal

      Returns Promise<
          {
              buttons: { label: string; type: string }[];
              document: any;
              empty: { document: { id: string; img: string; name: any }; include: any };
              searchTerm: any;
              sections: DocumentSelectorSection[];
              selected: string;
              showSectionHeaders: boolean;
          },
      >

    • Render selector and wait for it to resolve.

      Parameters

      • options: object

        Options

      Returns Promise<null | string | false | Document<any, any, null>>

      • Document or string for selected item, null if cancelled, or false or empty string if none were selected.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods