Class ActorSheetFlags

Hierarchy

  • DocumentSheet
    • ActorSheetFlags

Constructors

constructor

Accessors

title defaultOptions

Methods

_getFlags _updateObject getData

Constructors

constructor

  • Parameters

    • object: Document<any, any, Metadata<any>>

      Some object or entity which is the target to be updated.

    • Optional options: Partial<DocumentSheetOptions>

      Additional options which modify the rendering of the sheet. (default: {})

    Returns ActorSheetFlags

    Remarks

    Foundry allows passing no value to the constructor at all.

  • Parameters

    • Rest ...args: [Document<any, any, Metadata<any>>, Partial<DocumentSheetOptions>?]

    Returns ActorSheetFlags

Accessors

title

Static defaultOptions

  • get defaultOptions(): InsertKeys<{
        baseApplication: null | string;
        classes: string[];
        closeOnSubmit: boolean;
        dragDrop: Omit<DragDropConfiguration, "permissions" | "callbacks">[];
        editable: boolean;
        filters: Omit<SearchFilterConfiguration, "callback">[];
        height: null | number | "auto";
        id: string;
        left: null | number;
        minimizable: boolean;
        popOut: boolean;
        resizable: boolean;
        scale: null | number;
        scrollY: string[];
        sheetConfig: boolean;
        submitOnChange: boolean;
        submitOnClose: boolean;
        tabs: Omit<TabsConfiguration, "callback">[];
        template: string;
        title: string;
        top: null | number;
        viewPermission: 0 | 1 | 2 | 3;
        width: number;
    }, OmitByValue<{
        classes: string[];
        closeOnSubmit: boolean;
        id: string;
        template: string;
        width: number;
    }, never>>

  • Returns InsertKeys<{
        baseApplication: null | string;
        classes: string[];
        closeOnSubmit: boolean;
        dragDrop: Omit<DragDropConfiguration, "permissions" | "callbacks">[];
        editable: boolean;
        filters: Omit<SearchFilterConfiguration, "callback">[];
        height: null | number | "auto";
        id: string;
        left: null | number;
        minimizable: boolean;
        popOut: boolean;
        resizable: boolean;
        scale: null | number;
        scrollY: string[];
        sheetConfig: boolean;
        submitOnChange: boolean;
        submitOnClose: boolean;
        tabs: Omit<TabsConfiguration, "callback">[];
        template: string;
        title: string;
        top: null | number;
        viewPermission: 0 | 1 | 2 | 3;
        width: number;
    }, OmitByValue<{
        classes: string[];
        closeOnSubmit: boolean;
        id: string;
        template: string;
        width: number;
    }, never>>

Methods

_getFlags

_updateObject

  • _updateObject(event, formData): void

  • Update the Actor using the configured flags Remove/unset any flags which are no longer configured

    Parameters

    • event: any
    • formData: any

    Returns void

getData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc