Class AbilityChecks

model

name

• get name(): string

  The name of the registry

  Returns string

getLabels

• getLabels(options?: { sort?: boolean }): { [id: string]: string }

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

  Parameters

  • Optionaloptions: { sort?: boolean } = {}

    Additional options

    • Optionalsort?: boolean

      Sort result

  Returns { [id: string]: string }

  The names of each value in the registry, by id

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",
  });
  Copy

set

• set(id: string, content: SubAction): Registry<any>

  Sets the value of a key in the registry.

  Parameters

  • id: string

    ID of the value to set.

  • content: SubAction

    The value to set.

  Returns Registry<any>

  The registry itself, after the value has been set.

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

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