CombatantData

data. CombatantData

The data schema for a Combatant embedded document within a CombatEncounter document.

Constructor

new CombatantData(data, documentopt)

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

The _id which uniquely identifies this Combatant embedded document

tokenId string <optional>

The _id of a Token associated with this Combatant

name string <optional>

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

img string <optional>

A customized image which replaces the Token image in the tracker

initiative number <optional>

The initiative score for the Combatant which determines its turn order

hidden boolean <optional>
false

Is this Combatant currently hidden?

defeated boolean <optional>
false

Has this Combatant been defeated?

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 BaseCombatant <optional>

The document to which this data object belongs

Extends

  • DocumentData