Class TidyFlags

Manages Tidy flags.

Constructors

constructor

new TidyFlags(): TidyFlags
Returns TidyFlags

Properties

`Static`actionFilterOverride

actionFilterOverride: {
    key: "action-filter-override";
    prop: string;
    get(item: any): undefined | boolean;
    set(item: any, value: boolean): Promise<void>;
    unset(item: any): Promise<void>;
} = ...

Determines whether an item whose default Action List behavior has been overridden to be included (true) or excluded (false). undefined means there is no override and standard Action List logic should be used.

Type Declaration

key: "action-filter-override"
prop: string
get: function
- get(item: any): undefined | boolean
  Gets the item's Action Filter Override setting.
  Parameters
  - item: any
  Returns undefined | boolean
  - Defined in src/foundry/TidyFlags.ts:38
set: function
- set(item: any, value: boolean): Promise<void>
  Sets the item's Action Filter Override setting.
  Parameters
  - item: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:47
unset: function
- unset(item: any): Promise<void>
  Clears the item's Action Filter Override setting, meaning the item should use the standard Action List logic for inclusion or exclusion.
  Parameters
  - item: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:54

`Static`actionSection

actionSection: {
    key: "actionSection";
    prop: string;
    unsetProp: string;
    get(item: any): undefined | string;
    set(item: any, value: string): Promise<void>;
    unset(item: any): Promise<void>;
} = ...

Indicates a custom section name for a given item, which determines the item's section placement in the Actions tab.

Type Declaration

key: "actionSection"
prop: string
unsetProp: string
get: function
- get(item: any): undefined | string
  Gets the item's Action Section setting.
  Parameters
  - item: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:69
set: function
- set(item: any, value: string): Promise<void>
  Sets the item's Action Section setting.
  Parameters
  - item: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:81
unset: function
- unset(item: any): Promise<void>
  Clears the item's Action Section setting, meaning the item should use its default action section in the Actions tab.
  Parameters
  - item: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:89

`Static`age

age: {
    key: "age";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The age of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "age"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's age.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:181
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's age.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:187
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's age.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:191

`Static`appearance

appearance: {
    key: "appearance";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The appearance of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "appearance"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's appearance.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:204
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's appearance.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:211
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's appearance.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:215

`Static`attributePins

attributePins: {
    key: "attributePins";
    prop: string;
    get(actor: any): AttributePinFlag[];
    set(actor: any, value: AttributePinFlag[]): Promise<void>;
} = ...

Denotes the items and activities which have been pinned to the attributes tab.

Type Declaration

key: "attributePins"
prop: string
get: function
- get(actor: any): AttributePinFlag[]
  Gets the actor's Attribute tab pins.
  Parameters
  - actor: any
  Returns AttributePinFlag[]
  - Defined in src/foundry/TidyFlags.ts:227
set: function
- set(actor: any, value: AttributePinFlag[]): Promise<void>
  Sets the actor's Attribute tab pins.
  Parameters
  - actor: any
  - value: AttributePinFlag[]
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:236

`Static`combatantSettings

combatantSettings: {
    key: "combatantSettings";
    get(encounter: any): EncounterCombatantsSettings;
    set(encounter: any, settings: EncounterCombatantsSettings): Promise<void>;
} = ...

The combatant settings for encounter member NPCs.

Type Declaration

key: "combatantSettings"
get: function
- get(encounter: any): EncounterCombatantsSettings
  Gets encounter member NPC combatant settings.
  Parameters
  - encounter: any
  Returns EncounterCombatantsSettings
  - Defined in src/foundry/TidyFlags.ts:100
set: function
- set(encounter: any, settings: EncounterCombatantsSettings): Promise<void>
  Sets encounter member NPC combatant settings. It fully replaces the combatant settings object, since differentials will result in straggler data remaining behind.
  Parameters
  - encounter: any
  - settings: EncounterCombatantsSettings
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:112

`Static`documentJournal

documentJournal: {
    key: string;
    prop: string;
    get(doc: any): DocumentJournalEntries;
    set(doc: any, journal: DocumentJournalEntries): Promise<void>;
    unset(doc: any): void;
} = ...

An array of journal entries with an optional title and an HTML-based journal.

`Static`encounterDifficultyTargetGroupId

encounterDifficultyTargetGroupId: {
    key: "encounterDifficultyTargetGroupId";
    get(user: any): undefined | null | string;
    set(user: any, groupActorId: string): Promise<void>;
} = ...

The ID of the group which should be measured against when determine an encounter's difficulty.

Type Declaration

key: "encounterDifficultyTargetGroupId"
get: function
- get(user: any): undefined | null | string
  Gets the group ID.
  Parameters
  - user: any
  Returns undefined | null | string
  - Defined in src/foundry/TidyFlags.ts:134
set: function
- set(user: any, groupActorId: string): Promise<void>
  Sets the group ID.
  Parameters
  - user: any
  - groupActorId: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:141

`Static`exhaustion

exhaustion: {
    key: "exhaustion";
    prop: string;
    get(actor: any): undefined | number;
    set(actor: any, value: number): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The level exhaustion for a given actor. This flag applies to actors which don't yet possess standard exhaustion schema from the dnd5e system.

Type Declaration

key: "exhaustion"
prop: string
get: function
- get(actor: any): undefined | number
  Gets the actor's exhaustion level.
  Parameters
  - actor: any
  Returns undefined | number
  - Defined in src/foundry/TidyFlags.ts:250
set: function
- set(actor: any, value: number): Promise<void>
  Sets the actor's exhaustion level.
  Parameters
  - actor: any
  - value: number
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:257
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's exhaustion level.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:261

`Static`eyes

eyes: {
    key: "eyes";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The eyes of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "eyes"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's eyes.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:274
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's eyes.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:280
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's eyes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:284

`Static`faith

faith: {
    key: "faith";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The faith of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "faith"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's faith.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:297
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's faith.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:303
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's faith.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:307

`Static`gender

gender: {
    key: "gender";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The gender of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "gender"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's gender.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:320
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's gender.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:326
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's gender.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:330

`Static`hair

hair: {
    key: "hair";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The hair of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "hair"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's hair.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:343
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's hair.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:349
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's hair.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:353

`Static`height

height: {
    key: "height";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The height of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "height"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the actor's height.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:366
set: function
- set(actor: any, value: string): Promise<void>
  Sets the actor's height.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:372
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's height.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:376

`Static`includeRitualsInCanCast

includeRitualsInCanCast: {
    key: string;
    prop: string;
    get(document: any): boolean;
    set(document: any, value?: boolean): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Denotes whether to include all ritual spells in the "Can Cast" filter.

Type Declaration

key: string
prop: string
get: function
- get(document: any): boolean
  Gets whether to include rituals in the "Can Cast" spell filter.
  Parameters
  - document: any
  Returns boolean
  - Defined in src/foundry/TidyFlags.ts:388
set: function
- set(document: any, value?: boolean): Promise<void>
  Sets whether to include rituals in the "Can Cast" spell filter.
  Parameters
  - document: any
  - value: boolean = true
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:397
unset: function
- unset(document: any): Promise<void>
  Clears whether to include rituals in the "Can Cast" spell filter.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:405

`Static`includeSpellbookInNpcStatblockTab

includeSpellbookInNpcStatblockTab: {
    key: string;
    prop: string;
    get(document: any): null | boolean;
    set(document: any, value?: boolean): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Type Declaration

key: string
prop: string
get: function
- get(document: any): null | boolean
  Gets whether to include spellbook sections in the NPC Statblock tab.
  Parameters
  - document: any
  Returns null | boolean
  - Defined in src/foundry/TidyFlags.ts:446
set: function
- set(document: any, value?: boolean): Promise<void>
  Sets whether to include spellbook sections in the NPC Statblock tab.
  Parameters
  - document: any
  - value: boolean = true
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:455
unset: function
- unset(document: any): Promise<void>
  Clears whether to include spellbook sections in the NPC Statblock tab.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:463

`Static`inspirationSource

inspirationSource: {
    key: string;
    prop: string;
    get(document: any): string;
    set(document: any, itemId: string): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

An item ID which denotes an actor-owned item whose uses should be used for the banked inspiration tracker on the character sheet.

Type Declaration

key: string
prop: string
get: function
- get(document: any): string
  Gets an item ID or a blank string.
  Parameters
  - document: any
  Returns string
  - Defined in src/foundry/TidyFlags.ts:480
set: function
- set(document: any, itemId: string): Promise<void>
  Sets an item ID to represent an actor's source of inspiration value and max.
  Parameters
  - document: any
  - itemId: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:489
unset: function
- unset(document: any): Promise<void>
  Clears an actor's inspiration source, indicating to use the regular boolean tracker.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:497

`Static`inventoryGrid

inventoryGrid: {
    key: string;
    prop: string;
    get(document: any): boolean;
    set(document: any): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Denotes whether to show a grid for a given inventory screen.

Type Declaration

key: string
prop: string
get: function
- get(document: any): boolean
  Gets whether to show a grid for a given inventory screen.
  Parameters
  - document: any
  Returns boolean
  - Defined in src/foundry/TidyFlags.ts:509
set: function
- set(document: any): Promise<void>
  Sets whether to show a grid for a given inventory screen.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:516
unset: function
- unset(document: any): Promise<void>
  Clears whether to show a grid for a given inventory screen.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:520

`Static`motion

motion: {
    key: "motion";
    prop: string;
    get(actor: any): undefined | boolean;
    set(actor: any, value: boolean): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Denotes whether a vehicle is moving.

Type Declaration

key: "motion"
prop: string
get: function
- get(actor: any): undefined | boolean
  Gets whether a vehicle is moving.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in src/foundry/TidyFlags.ts:532
set: function
- set(actor: any, value: boolean): Promise<void>
  Sets whether a vehicle is moving.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:538
unset: function
- unset(actor: any): Promise<void>
  Clears whether a vehicle is moving.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:542

`Static`notes

notes: {
    key: "notes";
    members: {
        value: {
            key: "notes.value";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
    };
    prop: string;
    get(actor: any): undefined | TidyFlagUnnamedNotes;
    set(actor: any, value: TidyFlagUnnamedNotes): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Journal notes for an actor. This flag is for actors which don't yet have the standard notes schema.

Type Declaration

key: "notes"
members: {
    value: {
        key: "notes.value";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
}
The individual members of this flag. For flags that are not primitive values.
- value: {
      key: "notes.value";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes HTML.
  - key: "notes.value"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's notes HTML.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:578
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's notes HTML.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:587
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's notes HTML.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:595
prop: string
get: function
- get(actor: any): undefined | TidyFlagUnnamedNotes
  Gets the actor's journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagUnnamedNotes
  - Defined in src/foundry/TidyFlags.ts:555
set: function
- set(actor: any, value: TidyFlagUnnamedNotes): Promise<void>
  Sets the actor's journal notes.
  Parameters
  - actor: any
  - value: TidyFlagUnnamedNotes
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:564
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:568

`Static`notes1

notes1: {
    key: "notes1";
    members: {
        name: {
            key: "notes1.name";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
        value: {
            key: "notes1.value";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
    };
    prop: string;
    get(actor: any): undefined | TidyFlagNamedNotes;
    set(actor: any, value: TidyFlagNamedNotes): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Named journal notes for an actor. These notes represent extra notes that are available to actors for compartmentalizing notes.

Type Declaration

key: "notes1"
members: {
    name: {
        key: "notes1.name";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
    value: {
        key: "notes1.value";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
}
The individual members of this flag. For flags that are not primitive values.
- name: {
      key: "notes1.name";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes name.
  - key: "notes1.name"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's first named journal notes name.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:632
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's first named journal notes name.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:641
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's first named journal notes name.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:649
- value: {
      key: "notes1.value";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes HTML.
  - key: "notes1.value"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's first named journal notes HTML.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:658
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's first named journal notes HTML.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:667
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's first named journal notes HTML.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:675
prop: string
get: function
- get(actor: any): undefined | TidyFlagNamedNotes
  Gets the actor's first named journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagNamedNotes
  - Defined in src/foundry/TidyFlags.ts:611
set: function
- set(actor: any, value: TidyFlagNamedNotes): Promise<void>
  Sets the actor's first named journal notes.
  Parameters
  - actor: any
  - value: TidyFlagNamedNotes
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:618
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's first named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:622

`Static`notes2

notes2: {
    key: "notes2";
    members: {
        name: {
            key: "notes2.name";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
        value: {
            key: "notes2.value";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
    };
    prop: string;
    get(actor: any): undefined | TidyFlagNamedNotes;
    set(actor: any, value: TidyFlagNamedNotes): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Named journal notes for an actor. These notes represent extra notes that are available to actors for compartmentalizing notes.

Type Declaration

key: "notes2"
members: {
    name: {
        key: "notes2.name";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
    value: {
        key: "notes2.value";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
}
The individual members of this flag. For flags that are not primitive values.
- name: {
      key: "notes2.name";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes name.
  - key: "notes2.name"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's second named journal notes name.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:712
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's second named journal notes name.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:721
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's second named journal notes name.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:729
- value: {
      key: "notes2.value";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes HTML.
  - key: "notes2.value"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's second named journal notes HTML.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:738
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's second named journal notes HTML.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:747
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's second named journal notes HTML.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:755
prop: string
get: function
- get(actor: any): undefined | TidyFlagNamedNotes
  Gets the actor's second named journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagNamedNotes
  - Defined in src/foundry/TidyFlags.ts:691
set: function
- set(actor: any, value: TidyFlagNamedNotes): Promise<void>
  Sets the actor's second named journal notes.
  Parameters
  - actor: any
  - value: TidyFlagNamedNotes
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:698
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's second named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:702

`Static`notes3

notes3: {
    key: "notes3";
    members: {
        name: {
            key: "notes3.name";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
        value: {
            key: "notes3.value";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
    };
    prop: string;
    get(actor: any): undefined | TidyFlagNamedNotes;
    set(actor: any, value: TidyFlagNamedNotes): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Named journal notes for an actor. These notes represent extra notes that are available to actors for compartmentalizing notes.

Type Declaration

key: "notes3"
members: {
    name: {
        key: "notes3.name";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
    value: {
        key: "notes3.value";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
}
- name: {
      key: "notes3.name";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  - key: "notes3.name"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's third named journal notes name.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:790
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's third named journal notes name.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:799
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's third named journal notes name.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:807
- value: {
      key: "notes3.value";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  - key: "notes3.value"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's third named journal notes HTML.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:815
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's third named journal notes HTML.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:824
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's third named journal notes HTML.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:832
prop: string
get: function
- get(actor: any): undefined | TidyFlagNamedNotes
  Gets the actor's third named journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagNamedNotes
  - Defined in src/foundry/TidyFlags.ts:771
set: function
- set(actor: any, value: TidyFlagNamedNotes): Promise<void>
  Sets the actor's third named journal notes.
  Parameters
  - actor: any
  - value: TidyFlagNamedNotes
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:778
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's third named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:782

`Static`notes4

notes4: {
    key: "notes4";
    members: {
        name: {
            key: "notes4.name";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
        value: {
            key: "notes4.value";
            prop: string;
            get(actor: any): undefined | string;
            set(actor: any, value: string): Promise<void>;
            unset(actor: any): Promise<void>;
        };
    };
    prop: string;
    get(actor: any): undefined | TidyFlagNamedNotes;
    set(actor: any, value: TidyFlagNamedNotes): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Named journal notes for an actor. These notes represent extra notes that are available to actors for compartmentalizing notes.

Type Declaration

key: "notes4"
members: {
    name: {
        key: "notes4.name";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
    value: {
        key: "notes4.value";
        prop: string;
        get(actor: any): undefined | string;
        set(actor: any, value: string): Promise<void>;
        unset(actor: any): Promise<void>;
    };
}
The individual members of this flag. For flags that are not primitive values.
- name: {
      key: "notes4.name";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes name.
  - key: "notes4.name"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's fourth named journal notes name.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:869
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's fourth named journal notes name.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:878
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's fourth named journal notes name.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:886
- value: {
      key: "notes4.value";
      prop: string;
      get(actor: any): undefined | string;
      set(actor: any, value: string): Promise<void>;
      unset(actor: any): Promise<void>;
  }
  The notes HTML.
  - key: "notes4.value"
  - prop: string
  - get: function
    - get(actor: any): undefined | string
      Gets the actor's fourth named journal notes HTML.
      
      Parameters
      actor: any
      Returns undefined | string
      Defined in src/foundry/TidyFlags.ts:895
  - set: function
    - set(actor: any, value: string): Promise<void>
      Sets the actor's fourth named journal notes HTML.
      
      Parameters
      actor: any
      value: string
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:904
  - unset: function
    - unset(actor: any): Promise<void>
      Clears the actor's fourth named journal notes HTML.
      
      Parameters
      actor: any
      Returns Promise<void>
      Defined in src/foundry/TidyFlags.ts:912
prop: string
get: function
- get(actor: any): undefined | TidyFlagNamedNotes
  Gets the actor's fourth named journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagNamedNotes
  - Defined in src/foundry/TidyFlags.ts:848
set: function
- set(actor: any, value: TidyFlagNamedNotes): Promise<void>
  Sets the actor's fourth named journal notes.
  Parameters
  - actor: any
  - value: TidyFlagNamedNotes
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:855
unset: function
- unset(actor: any): Promise<void>
  Clears the actor's fourth named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:859

`Static`placeholders

placeholders: {
    key: "placeholders";
    prop: string;
    deleteEntry(actor: any, placeholderId: string): Promise<void>;
    get(actor: any): EncounterPlaceholders;
    insertOrUpdateEntry(
        actor: any,
        placeholder: EncounterPlaceholder,
    ): Promise<void>;
    set(actor: any, placeholders: EncounterPlaceholders): Promise<void>;
} = ...

Encounter sheet placeholders which can be managed on the Combat tab and which can be inserted into the Combat Tracker for the active encounter.

Type Declaration

key: "placeholders"
prop: string
deleteEntry: function
- deleteEntry(actor: any, placeholderId: string): Promise<void>
  Parameters
  - actor: any
  - placeholderId: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:949
get: function
- get(actor: any): EncounterPlaceholders
  Gets the placeholders for the specified encounter.
  Parameters
  - actor: any
  Returns EncounterPlaceholders
  - Defined in src/foundry/TidyFlags.ts:928
insertOrUpdateEntry: function
- insertOrUpdateEntry(
  actor: any,
  placeholder: EncounterPlaceholder,
  ): Promise<void>
  Inserts or updates a single entry in the current placeholders for the specified actor
  Parameters
  - actor: any
  - placeholder: EncounterPlaceholder
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:941
set: function
- set(actor: any, placeholders: EncounterPlaceholders): Promise<void>
  Sets the placeholders for the specified encounter.
  Parameters
  - actor: any
  - placeholders: EncounterPlaceholders
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:937

`Static`playerName

playerName: {
    key: "playerName";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The name of the player who owns the actor. This is informational and not used for game logic.

Type Declaration

key: "playerName"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the name of the player who owns the actor.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:969
set: function
- set(actor: any, value: string): Promise<void>
  Sets the name of the player who owns the actor.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:976
unset: function
- unset(actor: any): Promise<void>
  Clears the name of the player who owns the actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:980

`Static`section

section: {
    key: "section";
    prop: string;
    unsetProp: string;
    get(item: any): undefined | string;
    set(item: any, value: string): Promise<void>;
    unset(item: any): Promise<void>;
} = ...

Indicates a custom section name for a given item which determines the item's section placement in the item's default tab, as well as any other locations that aren't the Actions tab.

Type Declaration

key: "section"
prop: string
unsetProp: string
get: function
- get(item: any): undefined | string
  Gets the custom section name for an item.
  Parameters
  - item: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:996
set: function
- set(item: any, value: string): Promise<void>
  Sets the custom section name for an item.
  Parameters
  - item: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1005
unset: function
- unset(item: any): Promise<void>
  Clears the item's custom section setting, meaning the item should use its default section in the item's default tab, as well as any other locations that aren't the Actions tab.
  Parameters
  - item: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1014

`Static`sectionConfig

sectionConfig: {
    key: "sheet-section-config";
    prop: string;
    get(document: any): undefined | SheetTabSectionConfigs;
    set(document: any, value: SheetTabSectionConfigs): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Determines the order of item table sections for a given document sheet.

Type Declaration

key: "sheet-section-config"
prop: string
get: function
- get(document: any): undefined | SheetTabSectionConfigs
  Gets the document sheet's section configuration. undefined means to use the default settings.
  Parameters
  - document: any
  Returns undefined | SheetTabSectionConfigs
  - Defined in src/foundry/TidyFlags.ts:1024
set: function
- set(document: any, value: SheetTabSectionConfigs): Promise<void>
  Sets the document sheet's configuration.
  Parameters
  - document: any
  - value: SheetTabSectionConfigs
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1064
unset: function
- unset(document: any): Promise<void>
  Clears the document sheet's section config, meaning the target actor should use default settings.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1071

`Static`sections

sections: {
    key: "sections";
    prop: string;
    get(document: any): DocumentSectionAssignments;
    set(document: any, value: DocumentSectionAssignments): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

A map of UUIDs to section keys for sheets with sub-documents that cannot house their own section assignments.

Type Declaration

key: "sections"
prop: string
get: function
- get(document: any): DocumentSectionAssignments
  Gets the document's sub-document section assignments.
  Parameters
  - document: any
  Returns DocumentSectionAssignments
  - Defined in src/foundry/TidyFlags.ts:1083
set: function
- set(document: any, value: DocumentSectionAssignments): Promise<void>
  Sets the document's sub-document section assignments.
  Parameters
  - document: any
  - value: DocumentSectionAssignments
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1092
unset: function
- unset(document: any): Promise<void>
  Clears the document's sub-document section assignments.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1096

`Static`selectedTabs

selectedTabs: {
    key: "selected-tabs";
    prop: string;
    get(doc: any): undefined | string[];
    set(doc: any, value: string[]): Promise<void>;
    unset(doc: any): Promise<void>;
} = ...

The tabs that are currently selected for a given document. This is used to determine which tabs are visible in the document's sheet. When this field is empty, the document uses the default tabs.

Type Declaration

key: "selected-tabs"
prop: string
get: function
- get(doc: any): undefined | string[]
  Gets the selected tabs for a document.
  Parameters
  - doc: any
  Returns undefined | string[]
  - Defined in src/foundry/TidyFlags.ts:1111
set: function
- set(doc: any, value: string[]): Promise<void>
  Sets the selected tabs for a document.
  Parameters
  - doc: any
  - value: string[]
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1118
unset: function
- unset(doc: any): Promise<void>
  Clears the selected tabs for a document.
  Parameters
  - doc: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1122

`Static`sheetPins

sheetPins: {
    key: "sheetPins";
    prop: string;
    get(actor: any): SheetPinFlag[];
    set(actor: any, value: SheetPinFlag[]): Promise<void>;
} = ...

Denotes the items and activities which have been pinned to a significant tab on a sheet.

Type Declaration

key: "sheetPins"
prop: string
get: function
- get(actor: any): SheetPinFlag[]
  Gets the actor's sheet pins.
  Parameters
  - actor: any
  Returns SheetPinFlag[]
  - Defined in src/foundry/TidyFlags.ts:1134
set: function
- set(actor: any, value: SheetPinFlag[]): Promise<void>
  Sets the actor's sheet pins.
  Parameters
  - actor: any
  - value: SheetPinFlag[]
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1141

`Static`sheetThemeSettings

sheetThemeSettings: {
    key: string;
    prop: string;
    get(doc: any): undefined | null | ThemeSettingsV3;
    set(doc: any, settings: ThemeSettingsV3): Promise<void>;
    unset(doc: any): Promise<void>;
} = ...

`Static`showContainerPanel

showContainerPanel: {
    key: "showContainerPanel";
    prop: string;
    get(actor: any): undefined | boolean;
    set(actor: any, value: boolean): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Indicates whether the container panel should be shown for a given actor. This is used to determine whether the container panel is visible in the actor's inventory tab.

Type Declaration

key: "showContainerPanel"
prop: string
get: function
- get(actor: any): undefined | boolean
  Gets whether the container panel should be shown for an actor.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in src/foundry/TidyFlags.ts:1155
set: function
- set(actor: any, value: boolean): Promise<void>
  Sets whether the container panel should be shown for an actor.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1164
unset: function
- unset(actor: any): Promise<void>
  Clears whether the container panel should be shown for an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1168

`Static`showGroupMemberTabInfoPanel

showGroupMemberTabInfoPanel: {
    key: "showGroupMemberTabInfoPanel";
    prop: string;
    get(actor: any): boolean;
    set(actor: any, value: boolean): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Indicates whether the group member tab info panel should be shown for a given Group Sheet.

Type Declaration

key: "showGroupMemberTabInfoPanel"
prop: string
get: function
- get(actor: any): boolean
  Gets whether the group member tab info panel should be shown for a group.
  Parameters
  - actor: any
  Returns boolean
  - Defined in src/foundry/TidyFlags.ts:1180
set: function
- set(actor: any, value: boolean): Promise<void>
  Sets whether the group member tab info panel should be shown for a group.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1189
unset: function
- unset(actor: any): Promise<void>
  Clears whether the group member tab info panel should be shown for a group.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1197

`Static`showLegendariesOnNpcStatblock

showLegendariesOnNpcStatblock: {
    key: string;
    prop: string;
    get(document: any): null | boolean;
    set(document: any, value?: boolean): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Type Declaration

key: string
prop: string
get: function
- get(document: any): null | boolean
  Gets whether to show legendary panels in the NPC Statblock tab.
  Parameters
  - document: any
  Returns null | boolean
  - Defined in src/foundry/TidyFlags.ts:417
set: function
- set(document: any, value?: boolean): Promise<void>
  Sets whether to show legendary panels in the NPC Statblock tab.
  Parameters
  - document: any
  - value: boolean = true
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:426
unset: function
- unset(document: any): Promise<void>
  Clears whether to show legendary panels in the NPC Statblock tab.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:434

`Static`showNpcPersonalityInfo

showNpcPersonalityInfo: {
    key: "showNpcPersonalityInfo";
    prop: string;
    get(actor: any): undefined | boolean;
    set(actor: any, value: boolean): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Indicates whether the additional personality info should be shown for a given NPC on the biography tab.

Type Declaration

key: "showNpcPersonalityInfo"
prop: string
get: function
- get(actor: any): undefined | boolean
  Gets whether the additional personality info should be shown for an NPC.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in src/foundry/TidyFlags.ts:1213
set: function
- set(actor: any, value: boolean): Promise<void>
  Sets whether the additional personality info should be shown for an NPC.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1222
unset: function
- unset(actor: any): Promise<void>
  Clears whether the additional personality info should be shown for an NPC.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1230

`Static`sidebarTabConfiguration

sidebarTabConfiguration: {
    key: string;
    prop: string;
    get(doc: any): undefined | null | SheetTabConfiguration;
    set(doc: any, config: SheetTabConfiguration): Promise<void>;
    unset(doc: any): Promise<void>;
} = ...

Configuration for sheet sidebar tabs. Controls aspects like whether to include tabs.

Type Declaration

key: string
prop: string
get: function
- get(doc: any): undefined | null | SheetTabConfiguration
  Gets sidebar tab configuration.
  Parameters
  - doc: any
  Returns undefined | null | SheetTabConfiguration
  - Defined in src/foundry/TidyFlags.ts:1330
set: function
- set(doc: any, config: SheetTabConfiguration): Promise<void>
  Sets sidebar tab configuration.
  Parameters
  - doc: any
  - config: SheetTabConfiguration
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1345
unset: function
- unset(doc: any): Promise<void>
  Clears sidebar tab configuration.
  Parameters
  - doc: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1356

`Static`skillsExpanded

skillsExpanded: {
    key: "skillsExpanded";
    prop: string;
    get(actor: any): undefined | boolean;
    set(actor: any, value: boolean): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

Indicates whether the skills section should be expanded for a given actor. If this is set to true, all skills are shown. If this is set to false, unproficient skills are hidden and the rest are shown.

Type Declaration

key: "skillsExpanded"
prop: string
get: function
- get(actor: any): undefined | boolean
  Gets whether the skills section should be expanded for an actor.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in src/foundry/TidyFlags.ts:1244
set: function
- set(actor: any, value: boolean): Promise<void>
  Sets whether the skills section should be expanded for an actor.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1251
unset: function
- unset(actor: any): Promise<void>
  Clears whether the skills section should be expanded for an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1255

`Static`skin

skin: {
    key: "skin";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The skin of an actor. This is informational and not used for game logic.

Type Declaration

key: "skin"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the skin of an actor.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:1268
set: function
- set(actor: any, value: string): Promise<void>
  Sets the skin of an actor.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1274
unset: function
- unset(actor: any): Promise<void>
  Clears the skin of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1278

`Static`spellbookGrid

spellbookGrid: {
    key: string;
    prop: string;
    get(document: any): boolean;
    set(document: any): Promise<void>;
    unset(document: any): Promise<void>;
} = ...

Denotes whether to show a grid for a given spellbook screen.

Type Declaration

key: string
prop: string
get: function
- get(document: any): boolean
  Gets whether to show a grid for a given spellbook screen.
  Parameters
  - document: any
  Returns boolean
  - Defined in src/foundry/TidyFlags.ts:1290
set: function
- set(document: any): Promise<void>
  Sets whether to show a grid for a given spellbook screen.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1297
unset: function
- unset(document: any): Promise<void>
  Clears whether to show a grid for a given spellbook screen.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1301

`Static`tabConfiguration

tabConfiguration: {
    key: string;
    prop: string;
    get(doc: any): undefined | null | SheetTabConfiguration;
    set(doc: any, config: SheetTabConfiguration): Promise<void>;
    unset(doc: any): Promise<void>;
} = ...

Configuration for sheet tabs. Controls aspects like whether to include tabs.

Type Declaration

key: string
prop: string
get: function
- get(doc: any): undefined | null | SheetTabConfiguration
  Gets tab configuration.
  Parameters
  - doc: any
  Returns undefined | null | SheetTabConfiguration
  - Defined in src/foundry/TidyFlags.ts:1368
set: function
- set(doc: any, config: SheetTabConfiguration): Promise<void>
  Sets tab configuration.
  Parameters
  - doc: any
  - config: SheetTabConfiguration
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1383
unset: function
- unset(doc: any): Promise<void>
  Clears tab configuration.
  Parameters
  - doc: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1390

`Static`trait

trait: {
    key: "trait";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The trait of an actor. This is informational and not used for game logic.

Type Declaration

key: "trait"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the trait of an actor.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:1403
set: function
- set(actor: any, value: string): Promise<void>
  Sets the trait of an actor.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1409
unset: function
- unset(actor: any): Promise<void>
  Clears the trait of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1413

`Static`weight

weight: {
    key: "weight";
    prop: string;
    get(actor: any): undefined | string;
    set(actor: any, value: string): Promise<void>;
    unset(actor: any): Promise<void>;
} = ...

The weight of an actor. For this module, it is only an informational biographical field.

Type Declaration

key: "weight"
prop: string
get: function
- get(actor: any): undefined | string
  Gets the weight of an actor.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in src/foundry/TidyFlags.ts:1426
set: function
- set(actor: any, value: string): Promise<void>
  Sets the weight of an actor.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1432
unset: function
- unset(actor: any): Promise<void>
  Clears the weight of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in src/foundry/TidyFlags.ts:1436

Methods

`Static`getFlagPropertyPath

getFlagPropertyPath(key: string): string
Parameters
- key: string
Returns string
- Defined in src/foundry/TidyFlags.ts:25

`Static`setFlag

setFlag(flagged: any, flagName: string, value: unknown): Promise<void>
Sets a flag on a document.
Parameters
- flagged: any
  A document to set the flag on.
- flagName: string
  The name of the flag to set.
- value: unknown
  The value to set the flag to.
Returns Promise<void>
A promise that resolves when the flag is set.
- Defined in src/foundry/TidyFlags.ts:1464

`Static`tryGetFlag

tryGetFlag<T>(flagged: any, flagName: string): undefined | null | T
Attempts to get a flag from a document.
Type Parameters
- T
Parameters
- flagged: any
  A document which supports flags.
- flagName: string
  The name of the flag to get.
Returns undefined | null | T
The flag's value, or undefined if the flag is not set.

Remarks
This function is generic, but it is not performing parsing of the flag's value. It is simply doing an optimistic cast to the target type.
- Defined in src/foundry/TidyFlags.ts:1451

`Static`unsetFlag

unsetFlag(flagged: any, flagName: string): Promise<void>
Clears a flag from a document.
Parameters
- flagged: any
  A document to clear the flag from.
- flagName: string
  The name of the flag to clear.
Returns Promise<void>
A promise that resolves when the flag is cleared.
- Defined in src/foundry/TidyFlags.ts:1478

Class TidyFlags

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TidyFlags

Properties

StaticactionFilterOverride

Type Declaration

key: "action-filter-override"

prop: string

get: function

Parameters

Returns undefined | boolean

set: function

Parameters

Returns Promise<void>

unset: function

Parameters

Returns Promise<void>

StaticactionSection

Type Declaration

key: "actionSection"

prop: string

unsetProp: string

get: function

Parameters

Returns undefined | string

set: function

Parameters

Returns Promise<void>

unset: function

Parameters

Returns Promise<void>

Staticage

Type Declaration

key: "age"

prop: string

get: function

Parameters

Returns undefined | string

set: function

Parameters

Returns Promise<void>

unset: function

Parameters

Returns Promise<void>

Staticappearance

Type Declaration

key: "appearance"

prop: string

get: function

Parameters

Returns undefined | string

set: function

Parameters

Returns Promise<void>

unset: function

Parameters

Returns Promise<void>

StaticattributePins

Type Declaration

key: "attributePins"

prop: string

get: function

Parameters

Returns AttributePinFlag[]

set: function

Parameters

Returns Promise<void>

StaticcombatantSettings

Type Declaration

key: "combatantSettings"

get: function

Parameters

Returns EncounterCombatantsSettings

set: function

Parameters

`Static`actionFilterOverride

`Static`actionSection

`Static`age

`Static`appearance

`Static`attributePins

`Static`combatantSettings

`Static`documentJournal

`Static`encounterDifficultyTargetGroupId

`Static`exhaustion

`Static`eyes

`Static`faith

`Static`gender

`Static`hair