Class Conditions

The singleton registry of condition types. At runtime this registry is accessible as pf1.registry.conditions.

See

Hierarchy (View Summary)

Constructors

constructor

Properties

model _defaultData HUD_EXCLUDE_INANIMATE model SET_TO_ZERO TRACKS

Accessors

name tracks

Methods

conditionsInTrack getLabels localize register set setup toObject trackedConditions unregister

Constructors

constructor

Properties

model

model: Condition

The class each of this registry's content is expected to be an instance of.

See

Registry.model

Static_defaultData

_defaultData: (
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts: string[];
            flags: string[];
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts: string[];
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab: boolean;
        showInDefense?: undefined;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts: string[];
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: { changes?: undefined; contexts?: undefined; flags: string[] };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics: {
            changes: (
                | {
                    formula: number;
                    operator: string;
                    priority: number;
                    target: string;
                    type: string;
                }
                | {
                    formula: string;
                    operator: string;
                    priority?: undefined;
                    target: string;
                    type: string;
                }
            )[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud?: undefined;
        journal: string;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: (
                | {
                    continuous: boolean;
                    formula: string;
                    operator: string;
                    priority: number;
                    target: string;
                    type: string;
                }
                | {
                    continuous?: undefined;
                    formula: number;
                    operator?: undefined;
                    priority?: undefined;
                    target: string;
                    type: string;
                }
            )[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: { formula: number; target: string; type: string }[];
            contexts?: undefined;
            flags?: undefined;
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: null;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction: boolean;
        showInBuffsTab?: undefined;
        showInDefense: boolean;
        texture: string;
        track: string;
    }
    | {
        _id: string;
        hud: { exclude: readonly ["haunt", "trap", "vehicle"] };
        journal: string;
        mechanics: {
            changes: {
                continuous: true;
                formula: 0;
                operator: "set";
                priority: 1001;
                target: string;
                type: "untypedPerm";
            }[];
            contexts?: undefined;
            flags: string[];
        };
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track?: undefined;
    }
    | {
        _id: string;
        hud?: undefined;
        journal?: undefined;
        mechanics?: undefined;
        name: string;
        showInAction?: undefined;
        showInBuffsTab?: undefined;
        showInDefense?: undefined;
        texture: string;
        track: string;
    }
)[] = ...

An array of data used to initialize this registry.

Static InternalHUD_EXCLUDE_INANIMATE

HUD_EXCLUDE_INANIMATE: { exclude: readonly ["haunt", "trap", "vehicle"] } = ...

Staticmodel

model: typeof Condition = Condition

The class each of this registry's content is expected to be an instance of.

Static InternalSET_TO_ZERO

SET_TO_ZERO: {
    continuous: true;
    formula: 0;
    operator: "set";
    priority: 1001;
    type: "untypedPerm";
} = ...

StaticTRACKS

TRACKS: readonly ["dying", "fear", "lethargy", "movement"] = ...

An array of allowed tracks of condition advancement.

Accessors

name

tracks

Methods

conditionsInTrack

  • conditionsInTrack(track: string): string[]

  • Get all conditions that have belong to a given track

    Parameters

    • track: string

      The given track to check for

    Returns string[]

    • An array of all conditions in the given track

getLabels

  • getLabels(): { [id: string]: string }

  • Returns an object of the registry's contents, with the id as key and the name as value.

    Returns { [id: string]: string }

    The names of each value in the registry, by id

Protectedlocalize

register

  • register(namespace: string, id: string, value: object): Registry<any>

  • Registers a new instance of Model with the registry, using a partial of its data as the base.

    Parameters

    • namespace: string

      The namespace for which this value is registered.

    • id: string

      The unique key of the value.

    • value: object

      A Partial of the data to use as the base for the new value.

    Returns Registry<any>

    The registry itself, after the value has been registered.

    Example

    pf1.registry.damageTypes.register("my-module", "my-damage-type", {
      name: "My Damage Type",
      img: "icons/svg/damage.svg",
      category: "physical",
    });

set

Protected Abstractsetup

toObject

  • toObject(source?: boolean): { [id: string]: object }

  • Returns the contents of this registry as object, using ids as keys.

    Parameters

    • Optionalsource: boolean = false

      Whether to include the source data instead of its prepared data for each value.

    Returns { [id: string]: object }

    The data of each value in the registry, by id

trackedConditions

unregister

  • unregister(namespace: string, id?: string): void

  • Unregisters a value from the registry, or if no id is provided, all values belonging to the namespace.

    Parameters

    • namespace: string

      The namespace for which this value is unregistered.

    • Optionalid: string

      The unique key of the value, or undefined to unregister all values belonging to the namespace.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods