Class Conditions

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

See

Hierarchy (view full)

Registry
- Conditions

Index

Constructors

constructor

new Conditions(): Conditions
Returns Conditions
Inherited from Registry.constructor
- Defined in module/registry/base-registry.mjs:35

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

An array of data used to initialise this registry.

`Static` `Internal`HUD_EXCLUDE_INANIMATE

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

`Static`model

model: typeof Condition = Condition

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

`Static` `Internal`SET_TO_ZERO

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

`Static`TRACKS

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

An array of allowed tracks of condition advancement.

Accessors

name

get name(): string
The name of the registry

Returns string
Inherited from Registry.name
- Defined in module/registry/base-registry.mjs:46

tracks

get tracks(): string[]
The allowed tracks.

Returns string[]
See
Conditions.TRACKS
- Defined in module/registry/conditions.mjs:824

Methods

conditionsInTrack

conditionsInTrack(track): 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
- Defined in module/registry/conditions.mjs:804

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
- [id: string]: string
Inherited from Registry.getLabels
- Defined in module/registry/base-registry.mjs:168

`Protected`localize

localize(): void
Protected
Localize registry and all their entries.

Called in i18nInit.

Returns void
Inherited from Registry.localize
- Defined in module/registry/base-registry.mjs:89

register

register(namespace, id, value): 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",
});
```
Inherited from Registry.register
- Defined in module/registry/base-registry.mjs:126

set

set(id, content): Registry<any>
Sets the value of a key in the registry.
Parameters
- id: string
  ID of the value to set.
- content: Condition
  The value to set.
Returns Registry<any>
The registry itself, after the value has been set.
Inherited from Registry.set
- Defined in module/registry/base-registry.mjs:102

`Protected` `Abstract`setup

setup(): void
Protected
Post-registry initialization entry preparation

Returns void
Inherited from Registry.setup
- Defined in module/registry/base-registry.mjs:80

toObject

toObject(source?): {
[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
- [id: string]: object
Inherited from Registry.toObject
- Defined in module/registry/base-registry.mjs:159

trackedConditions

trackedConditions(): string[][]
Get all tracks and their conditions

Returns string[][]
- Defined in module/registry/conditions.mjs:813

unregister

unregister(namespace, id?): 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
Inherited from Registry.unregister
- Defined in module/registry/base-registry.mjs:140

Class Conditions

See

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Conditions

Properties

model

See

Static_defaultData

Static InternalHUD_EXCLUDE_INANIMATE

Staticmodel

Static InternalSET_TO_ZERO

StaticTRACKS

Accessors

name

Returns string

tracks

Returns string[]

See

Methods

conditionsInTrack

Parameters

Returns string[]

getLabels

Returns { [id: string]: string; }

[id: string]: string

Protectedlocalize

Returns void

register

Parameters

Returns Registry<any>

Example

set

Parameters

Returns Registry<any>

Protected Abstractsetup

Returns void

toObject

Parameters

Returns { [id: string]: object; }

[id: string]: object

trackedConditions

Returns string[][]

unregister

Parameters

Returns void

Settings

On This Page

`Static`_defaultData

`Static` `Internal`HUD_EXCLUDE_INANIMATE

`Static`model

`Static` `Internal`SET_TO_ZERO

`Static`TRACKS

Returns {
[id: string]: string;
}

`Protected`localize

`Protected` `Abstract`setup

Returns {
[id: string]: object;
}