Class ActiveEffectRegistry

A singleton helper class that tracks the duration and expiry of ActiveEffects

Hierarchy (View Summary)

IterableWeakSet
- ActiveEffectRegistry

Index

Constructors

Accessors

Methods

_initialize [iterator] add addFromParent clear delete has refresh values

Constructors

constructor

new ActiveEffectRegistry(
entries?: Iterable<documents.ActiveEffect, void, unknown>,
): ActiveEffectRegistry
Parameters
- Optionalentries: Iterable<documents.ActiveEffect, void, unknown> = []
  The initial entries.
Returns ActiveEffectRegistry
Inherited from IterableWeakSet.constructor

Accessors

initialized

get initialized(): boolean
Has the registry been populated for the first time?

Returns boolean

Methods

_initialize

_initialize(): void
Internal
Populate the registry for the first time.

Returns void

[iterator]

"[iterator]"(): Generator<documents.ActiveEffect, void, unknown>
Enumerate the values.

Returns Generator<documents.ActiveEffect, void, unknown>
Inherited from IterableWeakSet.[iterator]

add

add(effect: documents.ActiveEffect): ActiveEffectRegistry
Register a single ActiveEffect document. If the document is already registered but no longer eligible for registration, it will be deleted.
Parameters
- effect: documents.ActiveEffect
Returns ActiveEffectRegistry
Overrides IterableWeakSet.add

addFromParent

addFromParent(document: documents.Actor | documents.Item): ActiveEffectRegistry
Register the ActiveEffects embedded on an Actor or Item.
Parameters
- document: documents.Actor | documents.Item
Returns ActiveEffectRegistry

clear

clear(): void
Clear all values from the set.

Returns void
Inherited from IterableWeakSet.clear

delete

delete(value: documents.ActiveEffect): boolean
Delete a value from the set.
Parameters
- value: documents.ActiveEffect
  The value to delete.
Returns boolean
Inherited from IterableWeakSet.delete

has

has(value: documents.ActiveEffect): boolean
Whether this set contains the given value.
Parameters
- value: documents.ActiveEffect
  The value to test.
Returns boolean
Inherited from IterableWeakSet.has

refresh

refresh(
event: string,
context?: { actors?: Set<documents.Actor>; combat?: documents.Combat },
): Promise<void>
Refresh the durations of registered ActiveEffects and perform the configured action for expired effects.
Parameters
- event: string
  The expiry or other event that triggered this call
- Optionalcontext: { actors?: Set<documents.Actor>; combat?: documents.Combat }
  Additional contextual data relevant to the event
  - Optionalactors?: Set<documents.Actor>
    Limit the refresh to effects belonging to the provided list of actors.
  - Optionalcombat?: documents.Combat
    The Combat associated with this event
Returns Promise<void>
See
CONFIG.ActiveEffect.expiryAction

values

values(): Generator<documents.ActiveEffect, void, unknown>
Enumerate the collection.

Returns Generator<documents.ActiveEffect, void, unknown>
Inherited from IterableWeakSet.values