Class Conditions

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

See

Hierarchy

Constructors

constructor

Properties

model SET_TO_ZERO TRACKS _defaultData model

Accessors

name tracks

Methods

conditionsInTrack getLabels register set setup toObject trackedConditions unregister

Constructors

constructor

Properties

model

model: Condition = null

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

See

Registry.model

Static Internal SET_TO_ZERO

SET_TO_ZERO: {
    continuous: boolean;
    formula: number;
    operator: string;
    priority: number;
    type: string;
} = ...

Type declaration

  • continuous: boolean
  • formula: number
  • operator: string
  • priority: number
  • type: string

Static TRACKS

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

An array of allowed tracks of condition advancement.

Static _defaultData

_defaultData: ({
    _id: string;
    journal: string;
    mechanics?: undefined;
    name: string;
    showInAction: boolean;
    showInDefense: boolean;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags: string[];
    };
    name: string;
    showInAction?: undefined;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics?: undefined;
    name: string;
    showInAction?: undefined;
    showInDefense: boolean;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics?: undefined;
    name: string;
    showInAction: boolean;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction: boolean;
    showInDefense: boolean;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction?: undefined;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction?: undefined;
    showInDefense: boolean;
    texture: string;
    track: string;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction: boolean;
    showInDefense?: undefined;
    texture: string;
    track: string;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            continuous: boolean;
            formula: number;
            operator: string;
            priority: number;
            target: string;
            type: string;
        }[];
        flags: string[];
    };
    name: string;
    showInAction: boolean;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    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;
    showInDefense: boolean;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics?: undefined;
    name: string;
    showInAction?: undefined;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction?: undefined;
    showInDefense?: undefined;
    texture: string;
    track: string;
} | {
    _id: string;
    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;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
} | {
    _id: string;
    journal: string;
    mechanics: {
        changes: {
            formula: number;
            target: string;
            type: string;
        }[];
        flags?: undefined;
    };
    name: string;
    showInAction: boolean;
    showInDefense: boolean;
    texture: string;
    track: string;
} | {
    _id: string;
    journal: null;
    mechanics: {
        changes: {
            continuous: boolean;
            formula: number;
            operator: string;
            priority: number;
            target: string;
            type: string;
        }[];
        flags: string[];
    };
    name: string;
    showInAction: boolean;
    showInDefense?: undefined;
    texture: string;
    track?: undefined;
})[] = ...

An array of data used to initialise this registry.

Static model

model: typeof Condition = Condition

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

Accessors

name

tracks

Methods

conditionsInTrack

  • 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

  • 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

register

  • 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

setup

toObject

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

    Parameters

    • Optional source: 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

trackedConditions

unregister

  • 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.

    • Optional id: string

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

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc