Class BaseCard

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

mixes: CardData
memberof: documents
param data: Initial data from which to construct the Card
param context: Construction context options

Hierarchy

Document
- BaseCard

Index

Constructors

constructor

Methods

Properties

Accessors

TYPES

Constructors

constructor

new BaseCard(): BaseCard

Inherited from Document.constructor
Returns BaseCard

Methods

testUserPermission

testUserPermission(user: any, permission: any, __namedParameters?: { exact: boolean }): any

Inherited from Document.testUserPermission

Test whether a certain User has a requested permission level (or greater) over the Document

Parameters
- user: any
  
  The User being tested
- permission: any
  
  The permission level from DOCUMENT_OWNERSHIP_LEVELS to test
- __namedParameters: { exact: boolean } = {}
  
  Additional options involved in the permission test
  - exact: boolean
Returns any
Does the user have this permission level over the Document?

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; description: HTMLField; type: StringField; system: TypeDataField; suit: StringField; value: NumberField; back: SchemaField; faces: ArrayField; face: NumberField; drawn: BooleanField; origin: ForeignDocumentField; width: NumberField; height: NumberField; rotation: AngleField; sort: IntegerSortField; flags: ObjectField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; description: HTMLField; type: StringField; system: TypeDataField; suit: StringField; value: NumberField; back: SchemaField; faces: ArrayField; face: NumberField; drawn: BooleanField; origin: ForeignDocumentField; width: NumberField; height: NumberField; rotation: AngleField; sort: IntegerSortField; flags: ObjectField }
- _id: DocumentIdField
- name: StringField
- description: HTMLField
- type: StringField
- system: TypeDataField
- suit: StringField
- value: NumberField
- back: SchemaField
- faces: ArrayField
- face: NumberField
- drawn: BooleanField
- origin: ForeignDocumentField
- width: NumberField
- height: NumberField
- rotation: AngleField
- sort: IntegerSortField
- flags: ObjectField

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

Static Private #canCreate

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

Is a User able to create a new Card within this parent?

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

Static Private #canUpdate

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

Is a user able to update an existing Card?

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

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-joker.svg"

The default icon used for a Card face that does not have a custom image set

Accessors

Static TYPES

get TYPES(): string[]

The allowed set of Card types which may exist

Returns string[]