Class ActorTraitSelector

A specialized form used to select types.

Hierarchy

HandlebarsApplication<this> & DocumentSheetV2<
    any,
    RenderContext<any>,
    Configuration<any>,
    RenderOptions,
    this,
>
- ActorTraitSelector

Index

Constructors

constructor

new ActorTraitSelector(options: any): ActorTraitSelector
Parameters
- options: any
Returns ActorTraitSelector
Overrides HandlebarsApplicationMixin(DocumentSheetV2).constructor
- Defined in module/applications/trait-selector.mjs:67

Properties

`Internal`_collator

_collator: Collator = ...

Collator for sorting

`Internal`_searchFilter

_searchFilter: string = ""

Current search filter

_searchIndex

_searchIndex: { _id: Prepared; _name: Prepared; id: string }[]

attributes

attributes: { custom: Set<any>; standard: Set<any> }

The currently stored values for this trait selector

`Static`DEFAULT_OPTIONS

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

`Static`PARTS

PARTS: {
footer: { template: string };
form: { scrollable: string[]; template: string };
} = ...

`Static`SEARCH_INCLUDE_ID

SEARCH_INCLUDE_ID: boolean = true

Include language agnostic ID in search.

Accessors

attribute

get attribute(): string
Return a reference to the target attribute

Returns string
- Defined in module/applications/trait-selector.mjs:169

title

get title(): string
Configure the title of the trait selector window

Returns string
Overrides HandlebarsApplicationMixin(DocumentSheetV2).title
- Defined in module/applications/trait-selector.mjs:158

Methods

_deleteCustomTag

_deleteCustomTag(event: Event): void
Internal
The event handler for deleting a custom tag.
Parameters
- event: Event
  The originating click event
Returns void
- Defined in module/applications/trait-selector.mjs:311

_onActiveCustomInput

_onActiveCustomInput(event: Event): void
Internal
The event handler for active keystrokes on the input field.
Parameters
- event: Event
  The originating keydown event
Returns void
- Defined in module/applications/trait-selector.mjs:269

_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
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onChangeForm
- Defined in module/applications/trait-selector.mjs:361

_onCustomInput

_onCustomInput(event: Event): void
Internal
The event handler for custom field input.
Parameters
- event: Event
  The originating input event
Returns void
- Defined in module/applications/trait-selector.mjs:253

`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
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onRender
- Defined in module/applications/trait-selector.mjs:197

_onSearch

_onSearch(query: string): void
Internal
Run a search on the provided list of options.
Parameters
- query: string
  The search string
Returns void
- Defined in module/applications/trait-selector.mjs:327

`Protected`_preparePartContext

_preparePartContext(
    partId: any,
): Promise<
    | undefined
    | {
        buttons?: undefined;
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    }
    | {
        buttons?: undefined;
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    },
>
Protected
Parameters
- partId: any
Returns Promise<
    | undefined
    | {
        buttons?: undefined;
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    }
    | {
        buttons?: undefined;
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    },
>
Inherit Doc
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._preparePartContext
- Defined in module/applications/trait-selector.mjs:108

splitCustom

splitCustom(value: string): string[]
Split a given value based on the configured separator
Parameters
- value: string
  The value to split
Returns string[]
The split values, with empty values filtered out
- Defined in module/applications/trait-selector.mjs:181

Class ActorTraitSelector

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ActorTraitSelector

Properties

Internal_collator

Internal_searchFilter

_searchIndex

attributes

StaticDEFAULT_OPTIONS

StaticPARTS

StaticSEARCH_INCLUDE_ID

Accessors

attribute

Returns string

title

Returns string

Methods

_deleteCustomTag

Parameters

Returns void

_onActiveCustomInput

Parameters

Returns void

_onChangeForm

Parameters

Returns void

_onCustomInput

Parameters

Returns void

Protected_onRender

Parameters

Returns void

_onSearch

Parameters

Returns void

Protected_preparePartContext

Parameters

Inherit Doc

splitCustom

Parameters

Returns string[]

Settings

On This Page

`Internal`_collator

`Internal`_searchFilter

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Static`SEARCH_INCLUDE_ID

`Protected`_onRender

`Protected`_preparePartContext