Class ActiveEffectPF

Hierarchy

ActiveEffect
- ActiveEffectPF

Index

Constructors

Accessors

_hasDuration actor initiative isSuppressed isTemporary isTracker

Methods

_onCreate _onDelete _onUpdate _preCreate

Constructors

constructor

new ActiveEffectPF(...args): ActiveEffectPF
Parameters
- Rest...args: [data?: ActiveEffectDataConstructorData, context?: Context<ActorPF | ItemPF>]
Returns ActiveEffectPF
Inherited from ActiveEffect.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/data/documents/active-effect.d.ts:21

Accessors

_hasDuration

get _hasDuration(): boolean
Internal
Temporary solution until Foundry v12 to deal with problems of isTemporary.

Returns boolean
- Has duration
- Defined in module/documents/active-effect.mjs:129

actor

get actor(): null | Actor
Parent actor

Returns null | Actor
Remarks
- Null if no parent exists.
- Defined in module/documents/active-effect.mjs:93

initiative

get initiative(): undefined | number
Initiative counter

Present only if the AE was started during combat

Returns undefined | number
- Defined in module/documents/active-effect.mjs:142

isSuppressed

get isSuppressed(): boolean
Returns boolean
Overrides ActiveEffect.isSuppressed
- Defined in module/documents/active-effect.mjs:159

isTemporary

get isTemporary(): boolean
Returns boolean
Remarks
BUG: Foundry v11 and older controls visibility through this.
Overrides ActiveEffect.isTemporary
- Defined in module/documents/active-effect.mjs:104

isTracker

get isTracker(): boolean
Tracking a buff

Returns boolean
Remarks
- There should be only one tracker per item.
- Defined in module/documents/active-effect.mjs:154

Methods

_onCreate

_onCreate(data, context, userId): void
Parameters
- data: object
  Creation data
- context: object
  Context
- userId: string
  Triggering user
Returns void
Overrides ActiveEffect._onCreate
- Defined in module/documents/active-effect.mjs:32

_onDelete

_onDelete(context, userId): void
Parameters
- context: object
  Delete context
- userId: string
  Triggering user
Returns void
Overrides ActiveEffect._onDelete
- Defined in module/documents/active-effect.mjs:51

_onUpdate

_onUpdate(changed, context, userId): void
Parameters
- changed: any
- context: any
- userId: any
Returns void
Overrides ActiveEffect._onUpdate
- Defined in module/documents/active-effect.mjs:71

_preCreate

_preCreate(data, context, user): Promise<void>
Internal
Parameters
- data: object
  Creation data
- context: object
  Creation context
- user: User
  Triggering user
Returns Promise<void>
Overrides ActiveEffect._preCreate
- Defined in module/documents/active-effect.mjs:9