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

    Class MaterialSelector

    A specialized app used to select material types.

    Hierarchy

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
      • MaterialSelector
    Index

    Constructors

    constructor

    Properties

    DEFAULT_OPTIONS PARTS

    Accessors

    action document hasBase isEditable item material path title

    Methods

    _canRender _configureRenderOptions _initializeApplicationOptions _onChangeForm _onClose _onFirstRender _onRender _prepareMaterialsAndAddons _preparePartContext getStructure

    Constructors

    • Applications are constructed by providing an object of configuration options.

      Parameters

      • Optionaloptions: {}

        Options used to configure the Application instance (default: {})

      Returns MaterialSelector

    Properties

    DEFAULT_OPTIONS: {
        classes: string[];
        form: { closeOnSubmit: boolean; handler: Object; submitOnChange: boolean };
        id: string;
        position: { width: number };
        sheetConfig: boolean;
        tag: string;
        window: { icon: string; minimizable: boolean; resizable: boolean };
    } = ...
    PARTS: {
        footer: { template: string };
        form: { scrollable: string[]; template: string };
    } = ...

    Accessors

    • get document(): Document<any, any, null>

      The Document instance associated with the application

      Returns Document<any, any, null>

    • get hasBase(): boolean

      Return whether the document has a base material

      Returns boolean

    • get isEditable(): boolean

      Copy of DocumentSheet isEditable

      Returns boolean

    • get item(): ItemPF

      Returns ItemPF

    • get material(): object

      Get material data from document

      Returns object

    • get path(): string

      Return the target attribute

      Returns string

    • get title(): string

      Configure the title of the trait selector window

      Returns string

    Methods

    _canRender

    • _canRender(options: any): undefined | false

      Parameters

      • options: any

      Returns undefined | false

    _configureRenderOptions

    • _configureRenderOptions(options: any): void

      Parameters

      • options: any

      Returns void

    _initializeApplicationOptions

    • _initializeApplicationOptions(options: object): object

      Parameters

      • options: object

        The options for the application.

      Returns object

      • The initialized options.

    _onChangeForm

    • _onChangeForm(formConfig: ApplicationFormConfiguration, event: Event): void
      Internal

      The event handler for changes to form input elements

      Parameters

      • formConfig: ApplicationFormConfiguration

        The configuration of the form being changed

      • event: Event

        The triggering event

      Returns void

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    _onFirstRender

    • _onFirstRender(context: any, options: any): void

      Parameters

      • context: any
      • options: any

      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

    _prepareMaterialsAndAddons

    • _prepareMaterialsAndAddons(): {
          addons: { key: string; name: string }[];
          basics: {};
          materials: {};
      }

      Returns { addons: { key: string; name: string }[]; basics: {}; materials: {} }

    Protected_preparePartContext

    • _preparePartContext(
          partId: any,
      ): Promise<
          | undefined
          | {
              buttons?: undefined;
              choices: {
                  addons: { key: string; name: string }[];
                  basics: {};
                  materials: {};
              };
              cssClass: string;
              hasBase: boolean;
              materialAddons: {};
              materials: object;
          }
          | {
              buttons?: undefined;
              choices?: undefined;
              cssClass?: undefined;
              hasBase?: undefined;
              materialAddons?: undefined;
              materials?: undefined;
          }
          | {
              buttons: { icon: string; label: string; type: string }[];
              choices?: undefined;
              cssClass?: undefined;
              hasBase?: undefined;
              materialAddons?: undefined;
              materials?: undefined;
          },
      >
      Protected

      Parameters

      • partId: any

      Returns Promise<
          | undefined
          | {
              buttons?: undefined;
              choices: {
                  addons: { key: string; name: string }[];
                  basics: {};
                  materials: {};
              };
              cssClass: string;
              hasBase: boolean;
              materialAddons: {};
              materials: object;
          }
          | {
              buttons?: undefined;
              choices?: undefined;
              cssClass?: undefined;
              hasBase?: undefined;
              materialAddons?: undefined;
              materials?: undefined;
          }
          | {
              buttons: { icon: string; label: string; type: string }[];
              choices?: undefined;
              cssClass?: undefined;
              hasBase?: undefined;
              materialAddons?: undefined;
              materials?: undefined;
          },
      >

    • Return the source information for the material selector

      Returns object

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods