ActiveEffectData

data. ActiveEffectData

The data schema for an ActiveEffect document.

Constructor

new ActiveEffectData(data, documentopt)

See:
  • BaseActiveEffect
Properties:
Name Type Attributes Default Description
_id string

The _id which uniquely identifies the ActiveEffect within a parent Actor or Item

label string

A text label which describes the name of the ActiveEffect

changes Array.<data.EffectChangeData>

The array of EffectChangeData objects which the ActiveEffect applies

disabled boolean <optional>
false

Is this ActiveEffect currently disabled?

duration data.EffectDurationData <optional>

An EffectDurationData object which describes the duration of the ActiveEffect

icon string <optional>

An icon image path used to depict the ActiveEffect

origin string <optional>

A UUID reference to the document from which this ActiveEffect originated

tint string <optional>
null

A color string which applies a tint to the ActiveEffect icon

transfer boolean <optional>
false

Does this ActiveEffect automatically transfer from an Item to an Actor?

flags object <optional>
{}

An object of optional key/value flags

Parameters:
Name Type Attributes Description
data object

Initial data used to construct the data object

document BaseActiveEffect <optional>

The document to which this data object belongs

Extends

  • DocumentData