Interface CombatantData

interface CombatantData {
    _id: null | string;
    _stats: DocumentStats;
    actorId?: string;
    defeated?: boolean;
    flags: DocumentFlags;
    group?: string;
    hidden?: boolean;
    img?: string;
    initiative?: number;
    name?: string;
    system?: object;
    tokenId?: string;
    type: string;
}

Properties

_id _stats actorId? defeated? flags group? hidden? img? initiative? name? system? tokenId? type

Properties

_id

_id: null | string

The _id which uniquely identifies this Combatant embedded document

_stats

_stats: DocumentStats

An object of creation and access information.

OptionalactorId

actorId?: string

The _id of an Actor associated with this Combatant

Optionaldefeated

defeated?: boolean

Has this Combatant been defeated?

flags

flags: DocumentFlags

An object of optional key/value flags

Optionalgroup

group?: string

An optional group this Combatant belongs to.

Optionalhidden

hidden?: boolean

Is this Combatant currently hidden?

Optionalimg

img?: string

A customized image which replaces the Token image in the tracker

Optionalinitiative

initiative?: number

The initiative score for the Combatant which determines its turn order

Optionalname

name?: string

A customized name which replaces the name of the Token in the tracker

Optionalsystem

system?: object

Game system data which is defined by system data models.

OptionaltokenId

tokenId?: string

The _id of a Token associated with this Combatant

type

type: string

The type of this Combatant.

Settings

Member Visibility

On This Page

Properties