Interface ActiveEffectData

interface ActiveEffectData {
    _id: null | string;
    changes: EffectChangeData[];
    description?: string;
    disabled?: boolean;
    duration?: EffectDurationData;
    flags: DocumentFlags;
    icon?: string;
    name: string;
    origin?: string;
    sort?: number;
    statuses?: Set<string>;
    system?: object;
    tint?: string;
    transfer?: boolean;
    type?: string;
}

Properties

_id changes description? disabled? duration? flags icon? name origin? sort? statuses? system? tint? transfer? type?

Properties

_id

_id: null | string

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

changes

changes: EffectChangeData[]

The array of EffectChangeData objects which the ActiveEffect applies

Optionaldescription

description?: string

The HTML text description for this ActiveEffect document.

Optionaldisabled

disabled?: boolean

Is this ActiveEffect currently disabled?

Optionalduration

duration?: EffectDurationData

An EffectDurationData object which describes the duration of the ActiveEffect

flags

flags: DocumentFlags

An object of optional key/value flags

Optionalicon

icon?: string

An icon image path used to depict the ActiveEffect

name

name: string

The name which describes the ActiveEffect

Optionalorigin

origin?: string

A UUID reference to the document from which this ActiveEffect originated

Optionalsort

sort?: number

The sort value

Optionalstatuses

statuses?: Set<string>

Special status IDs that pertain to this effect

Optionalsystem

system?: object

The system type data field

Optionaltint

tint?: string

A color string which applies a tint to the ActiveEffect icon

Optionaltransfer

transfer?: boolean

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

Optionaltype

type?: string

The document type

Settings

Member Visibility

On This Page

Properties