Class BaseCombat

The Document definition for a Combat. Defines the DataSchema and common behaviors for a Combat which are shared between both client and server.

mixes: CombatData
memberof: documents
param data: Initial data from which to construct the Combat
param context: Construction context options

Hierarchy

Document
- BaseCombat

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BaseCombat(): BaseCombat

Inherited from Document.constructor
Returns BaseCombat

Properties

Static metadata

metadata: any = ...

Default metadata which applies to each instance of this Document type.

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; scene: ForeignDocumentField; combatants: EmbeddedCollectionField; active: BooleanField; round: NumberField; turn: NumberField; sort: IntegerSortField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; scene: ForeignDocumentField; combatants: EmbeddedCollectionField; active: BooleanField; round: NumberField; turn: NumberField; sort: IntegerSortField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- scene: ForeignDocumentField
- combatants: EmbeddedCollectionField
- active: BooleanField
- round: NumberField
- turn: NumberField
- sort: IntegerSortField
- flags: ObjectField
- _stats: DocumentStatsField

Static Protected #canUpdate

#canUpdate(user: any, doc: any, data: any): boolean

Is a user able to update an existing Combat?

Parameters
- user: any
- doc: any
- data: any
Returns boolean