[Go to site: main page, start]

Interface ActiveEffectData

interface ActiveEffectData {
    _id: string | null;
    changes: EffectChangeData[];
    description: string;
    disabled: boolean;
    duration: EffectDurationData;
    flags: DocumentFlags;
    img: string;
    name: string;
    origin: string;
    showIcon: 0 | 1 | 2;
    sort: number;
    start: EffectStartData;
    statuses: string[];
    system: object;
    tint: string;
    transfer: boolean;
    type: string;
}
Index

Properties

_id: string | null

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

changes: EffectChangeData[]

The array of EffectChangeData objects which the ActiveEffect applies

description: string

The HTML text description for this ActiveEffect document.

disabled: boolean

Is this ActiveEffect currently disabled? Defaults to false.

An EffectDurationData object which describes the duration of the ActiveEffect

An object of optional key/value flags

img: string

An icon image path used to depict the ActiveEffect

name: string

The name which describes the ActiveEffect

origin: string

A UUID reference to the document from which this ActiveEffect originated

showIcon: 0 | 1 | 2

Should this ActiveEffect's image be prominently displayed as an icon alongside Tokens, Combatants, etc.? Defaults to a CONDITIONAL (1).

sort: number

The sort value. Defaults to 0.

Data pertaining to when the ActiveEffect was created.

statuses: string[]

Special status IDs that pertain to this effect

system: object

The system type data field

tint: string

A color string which applies a tint to the ActiveEffect icon. Defaults to "#FFFFFF".

transfer: boolean

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

type: string

The document type