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 foundry/TidyFlags.ts:26
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 foundry/TidyFlags.ts:35
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 foundry/TidyFlags.ts:42

`Static`actionSection

actionSection: {
    key: "actionSection";
    prop: 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
get:function
- get(item: any): undefined | string
- Gets the item's Action Section setting.
  Parameters
  - item: any
  Returns undefined | string
  - Defined in foundry/TidyFlags.ts:56
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 foundry/TidyFlags.ts:63
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 foundry/TidyFlags.ts:71

`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 foundry/TidyFlags.ts:84
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's age.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:90
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's age.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:94

`Static`allowEdit

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

Determines whether an actor's sheet should be editable per the sheet lock feature (default true).

Type declaration

key: string
prop: string
get:function
- get(document: any): boolean
- Denotes whether the sheet is in edit mode.
  Parameters
  - document: any
  Returns boolean
  - Defined in foundry/TidyFlags.ts:108
set:function
- set(document: any, value: boolean): Promise<void>
- Sets whether the sheet is in edit mode.
  Parameters
  - document: any
  - value: boolean
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:112
unset:function
- unset(document: any): Promise<void>
- Removes the actor's edit mode setting.
  Parameters
  - document: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:116

Param: actor

the actor

Returns

whether the sheet should be editable per the sheet lock feature

`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 foundry/TidyFlags.ts:129
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's appearance.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:136
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's appearance.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:140

`Static`classFilter

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

A field used to filter spells based on an indicated class, showing only spells whose system.sourceClass property matches this classFilter selection.

Type declaration

key: "classFilter"
prop: string
get:function
- get(actor: any): undefined | string
- Gets the actor's class filter.
  Parameters
  - actor: any
  Returns undefined | string
  - Defined in foundry/TidyFlags.ts:154
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's class filter.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:161
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's class filter.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:165

`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 foundry/TidyFlags.ts:179
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 foundry/TidyFlags.ts:186
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's exhaustion level.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:190

`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 foundry/TidyFlags.ts:203
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's eyes.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:209
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's eyes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:213

`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 foundry/TidyFlags.ts:226
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's faith.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:232
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's faith.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:236

`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 foundry/TidyFlags.ts:249
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's gender.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:255
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's gender.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:259

`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 foundry/TidyFlags.ts:272
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's hair.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:278
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's hair.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:282

`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 foundry/TidyFlags.ts:295
set:function
- set(actor: any, value: string): Promise<void>
- Sets the actor's height.
  Parameters
  - actor: any
  - value: string
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:301
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's height.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:305

`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 foundry/TidyFlags.ts:317
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 foundry/TidyFlags.ts:324
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 foundry/TidyFlags.ts:328

`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 foundry/TidyFlags.ts:340
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 foundry/TidyFlags.ts:346
unset:function
- unset(actor: any): Promise<void>
- Clears whether a vehicle is moving.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:350

`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 foundry/TidyFlags.ts:386
  - 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 foundry/TidyFlags.ts:395
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's notes HTML.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:403
prop: string
get:function
- get(actor: any): undefined | TidyFlagUnnamedNotes
- Gets the actor's journal notes.
  Parameters
  - actor: any
  Returns undefined | TidyFlagUnnamedNotes
  - Defined in foundry/TidyFlags.ts:363
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 foundry/TidyFlags.ts:372
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:376

`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 foundry/TidyFlags.ts:440
  - 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 foundry/TidyFlags.ts:449
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's first named journal notes name.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:457
- 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 foundry/TidyFlags.ts:466
  - 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 foundry/TidyFlags.ts:475
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's first named journal notes HTML.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:483
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 foundry/TidyFlags.ts:419
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 foundry/TidyFlags.ts:426
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's first named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:430

`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 foundry/TidyFlags.ts:520
  - 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 foundry/TidyFlags.ts:529
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's second named journal notes name.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:537
- 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 foundry/TidyFlags.ts:546
  - 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 foundry/TidyFlags.ts:555
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's second named journal notes HTML.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:563
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 foundry/TidyFlags.ts:499
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 foundry/TidyFlags.ts:506
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's second named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:510

`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 foundry/TidyFlags.ts:598
  - 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 foundry/TidyFlags.ts:607
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's third named journal notes name.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:615
- 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 foundry/TidyFlags.ts:623
  - 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 foundry/TidyFlags.ts:632
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's third named journal notes HTML.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:640
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 foundry/TidyFlags.ts:579
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 foundry/TidyFlags.ts:586
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's third named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:590

`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 foundry/TidyFlags.ts:677
  - 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 foundry/TidyFlags.ts:686
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's fourth named journal notes name.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:694
- 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 foundry/TidyFlags.ts:703
  - 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 foundry/TidyFlags.ts:712
  - unset:function
    - unset(actor: any): Promise<void>
    - Clears the actor's fourth named journal notes HTML.
      Parameters
      actor: any
      Returns Promise<void>
      Defined in foundry/TidyFlags.ts:720
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 foundry/TidyFlags.ts:656
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 foundry/TidyFlags.ts:663
unset:function
- unset(actor: any): Promise<void>
- Clears the actor's fourth named journal notes.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:667

`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 foundry/TidyFlags.ts:735
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 foundry/TidyFlags.ts:742
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 foundry/TidyFlags.ts:746

`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 foundry/TidyFlags.ts:762
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 foundry/TidyFlags.ts:768
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 foundry/TidyFlags.ts:777

`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 foundry/TidyFlags.ts:787
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 foundry/TidyFlags.ts:827
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 foundry/TidyFlags.ts:834

`Static`selectedTabs

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

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

Type declaration

key: "selected-tabs"
prop: string
get:function
- get(actor: any): undefined | string[]
- Gets the selected tabs for an actor.
  Parameters
  - actor: any
  Returns undefined | string[]
  - Defined in foundry/TidyFlags.ts:849
set:function
- set(actor: any, value: string[]): Promise<void>
- Sets the selected tabs for an actor.
  Parameters
  - actor: any
  - value: string[]
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:856
unset:function
- unset(actor: any): Promise<void>
- Clears the selected tabs for an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:860

`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 foundry/TidyFlags.ts:874
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 foundry/TidyFlags.ts:883
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 foundry/TidyFlags.ts:887

`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 foundry/TidyFlags.ts:899
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 foundry/TidyFlags.ts:908
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 foundry/TidyFlags.ts:916

`Static`showLegendaryToolbar

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

Indicates whether the legendary toolbar should be shown for a given NPC.

Type declaration

key: "showLegendaryToolbar"
prop: string
get:function
- get(actor: any): undefined | boolean
- Gets whether the legendary toolbar should be shown for an NPC.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in foundry/TidyFlags.ts:931
set:function
- set(actor: any, value: boolean): Promise<void>
- Sets whether the legendary toolbar should be shown for an NPC.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:940
unset:function
- unset(actor: any): Promise<void>
- Clears whether the legendary toolbar should be shown for an NPC.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:948

`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 foundry/TidyFlags.ts:961
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 foundry/TidyFlags.ts:970
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 foundry/TidyFlags.ts:978

`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 foundry/TidyFlags.ts:992
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 foundry/TidyFlags.ts:999
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 foundry/TidyFlags.ts:1003

`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 foundry/TidyFlags.ts:1016
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 foundry/TidyFlags.ts:1022
unset:function
- unset(actor: any): Promise<void>
- Clears the skin of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:1026

`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 foundry/TidyFlags.ts:1038
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 foundry/TidyFlags.ts:1045
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 foundry/TidyFlags.ts:1049

`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 foundry/TidyFlags.ts:1062
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 foundry/TidyFlags.ts:1068
unset:function
- unset(actor: any): Promise<void>
- Clears the trait of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:1072

`Static`traitsExpanded

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

Indicates whether the traits section should be expanded for a given actor. If this is set to true, all traits are shown. If this is set to false, empty traits sections are hidden and the rest are shown. This does not apply to custom traits which are added through the Tidy API.

Type declaration

key: "traitsExpanded"
prop: string
get:function
- get(actor: any): undefined | boolean
- Gets whether the traits section should be expanded for an actor.
  Parameters
  - actor: any
  Returns undefined | boolean
  - Defined in foundry/TidyFlags.ts:1110
set:function
- set(actor: any, value: boolean): Promise<void>
- Sets whether the traits section should be expanded for an actor.
  Parameters
  - actor: any
  - value: boolean
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:1117
unset:function
- unset(actor: any): Promise<void>
- Clears whether the traits section should be expanded for an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:1121

`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 foundry/TidyFlags.ts:1085
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 foundry/TidyFlags.ts:1091
unset:function
- unset(actor: any): Promise<void>
- Clears the weight of an actor.
  Parameters
  - actor: any
  Returns Promise<void>
  - Defined in foundry/TidyFlags.ts:1095

Methods

`Static`getFlagPropertyPath

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

`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 foundry/TidyFlags.ts:1150

`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 foundry/TidyFlags.ts:1136

`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 foundry/TidyFlags.ts:1164

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

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>

StaticallowEdit

Type declaration

key: string

prop: string

get:function

Parameters

Returns boolean

set:function

Parameters

Returns Promise<void>

unset:function

Parameters

Returns Promise<void>

Param: actor

Returns

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>

StaticclassFilter

Type declaration

key: "classFilter"

prop: string

`Static`actionFilterOverride

`Static`actionSection

`Static`age

`Static`allowEdit

`Static`appearance

`Static`classFilter

`Static`exhaustion

`Static`eyes

`Static`faith

`Static`gender

`Static`hair