Class BaseCards

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

mixes: CardsData
memberof: documents
param data: Initial data from which to construct the Cards
param context: Construction context options

Hierarchy

Document
- BaseCards

Index

Constructors

constructor

Properties

Methods

Accessors

TYPES

Constructors

constructor

new BaseCards(): BaseCards

Inherited from Document.constructor
Returns BaseCards

Properties

Static metadata

metadata: any = ...

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

Static DEFAULT_ICON

DEFAULT_ICON: string = "icons/svg/card-hand.svg"

The default icon used for a cards stack that does not have a custom image set

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; type: StringField; description: HTMLField; img: FilePathField; system: SystemDataField; cards: EmbeddedCollectionField; width: NumberField; height: NumberField; rotation: AngleField; displayCount: BooleanField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; type: StringField; description: HTMLField; img: FilePathField; system: SystemDataField; cards: EmbeddedCollectionField; width: NumberField; height: NumberField; rotation: AngleField; displayCount: BooleanField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- type: StringField
- description: HTMLField
- img: FilePathField
- system: SystemDataField
- cards: EmbeddedCollectionField
- width: NumberField
- height: NumberField
- rotation: AngleField
- displayCount: BooleanField
- folder: ForeignDocumentField
- sort: IntegerSortField
- ownership: DocumentOwnershipField
- flags: ObjectField
- _stats: DocumentStatsField

Static migrateData

migrateData(data: any): any

inheritdoc
Parameters
- data: any
Returns any

Static shimData

shimData(data: any, options: any): any

inheritdoc
Parameters
- data: any
- options: any
Returns any

Accessors

Static TYPES

get TYPES(): string[]

The allowed set of CardsData types which may exist

Returns string[]