Class BaseFogExploration

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

mixes: FogExplorationData
memberof: documents
param data: Initial data from which to construct the FogExploration
param context: Construction context options

Hierarchy

Document
- BaseFogExploration

Index

Constructors

constructor

Methods

Properties

metadata

Constructors

constructor

new BaseFogExploration(): BaseFogExploration

Inherited from Document.constructor
Returns BaseFogExploration

Methods

_preUpdate

_preUpdate(changed: any, options: any, user: any): Promise<void>

Inherited from Document._preUpdate

Perform preliminary operations before a Document of this type is updated. Pre-update operations only occur for the client which requested the operation.

Parameters
- changed: any
  
  The differential data that is changed relative to the documents prior values
- options: any
  
  Additional options which modify the update request
- user: any
  
  The User requesting the document update
Returns Promise<void>

Static defineSchema

defineSchema(): { _id: DocumentIdField; scene: ForeignDocumentField; user: ForeignDocumentField; explored: FilePathField; positions: ObjectField; timestamp: NumberField; flags: ObjectField }

inheritdoc
Returns { _id: DocumentIdField; scene: ForeignDocumentField; user: ForeignDocumentField; explored: FilePathField; positions: ObjectField; timestamp: NumberField; flags: ObjectField }
- _id: DocumentIdField
- scene: ForeignDocumentField
- user: ForeignDocumentField
- explored: FilePathField
- positions: ObjectField
- timestamp: NumberField
- flags: ObjectField

Static Private #canModify

#canModify(user: any, doc: any): any

Test whether a User can modify a FogExploration document.

Parameters
- user: any
- doc: any
Returns any

Properties

Static metadata

metadata: any = ...

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