Class BaseCombatant

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

mixes: CombatantData
memberof: documents
param data: Initial data from which to construct the Combatant
param context: Construction context options

Hierarchy

Document
- BaseCombatant

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BaseCombatant(): BaseCombatant

Inherited from Document.constructor
Returns BaseCombatant

Properties

Static metadata

metadata: any = ...

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

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; actorId: ForeignDocumentField; tokenId: ForeignDocumentField; sceneId: ForeignDocumentField; name: StringField; img: FilePathField; initiative: NumberField; hidden: BooleanField; defeated: BooleanField; flags: ObjectField }

inheritdoc
Returns { _id: DocumentIdField; actorId: ForeignDocumentField; tokenId: ForeignDocumentField; sceneId: ForeignDocumentField; name: StringField; img: FilePathField; initiative: NumberField; hidden: BooleanField; defeated: BooleanField; flags: ObjectField }
- _id: DocumentIdField
- actorId: ForeignDocumentField
- tokenId: ForeignDocumentField
- sceneId: ForeignDocumentField
- name: StringField
- img: FilePathField
- initiative: NumberField
- hidden: BooleanField
- defeated: BooleanField
- flags: ObjectField

Static Private #canUpdate

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

Is a user able to update an existing Combatant?

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

Static Private #canCreate

#canCreate(user: any, doc: any, data: any): any

Is a user able to create this Combatant?

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