Constructor
new CombatData(data, documentopt)
- See:
-
- BaseCombat
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
_id |
string | The _id which uniquely identifies this Combat document |
||
scene |
string | The _id of a Scene within which this Combat occurs |
||
combatants |
Collection.<BaseCombatant> | A Collection of Combatant embedded Documents |
||
active |
boolean |
<optional> |
false
|
Is the Combat encounter currently active? |
round |
number |
<optional> |
0
|
The current round of the Combat encounter |
turn |
number | null |
<optional> |
0
|
The current turn in the Combat round |
sort |
number |
<optional> |
0
|
The current sort order of this Combat relative to others in the same Scene |
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 |
BaseCombat |
<optional> |
The document to which this data object belongs |
Extends
- DocumentData