Class CheckMessageModel

Data Model for basic check cards.

Hierarchy (View Summary)

BaseMessageModel
- CheckMessageModel

Index

Constructors

Properties

combat? config? dc? reference? subject?

Accessors

Methods

defineSchema pruneData

Constructors

constructor

new CheckMessageModel(): CheckMessageModel
Returns CheckMessageModel
Inherited from BaseMessageModel.constructor

Properties

`Optional`combat

combat?: string

Combat ID if this is message relates to any specific combat encounter.

`Optional`config

config?: object

Arbitrary config object

`Optional`dc

dc?: object

Difficulty Class

`Optional`reference

reference?: string

Reference to what triggered this message if anything.

`Optional`subject

subject?: object

Subject info object

Accessors

skill

get skill(): { rank: number }
Additional shim for metadata shim

Returns { rank: number }
- Skill data
Deprecated
- Use msg.system.config.rank instead.
Inherited from BaseMessageModel.skill
- Defined in module/models/chat/base-message.mjs:31

Methods

`Static`defineSchema

defineSchema(): {
    combat: any;
    config: any;
    dc: any;
    reference: any;
    subject: any;
}
Returns { combat: any; config: any; dc: any; reference: any; subject: any }
Overrides BaseMessageModel.defineSchema
- Defined in module/models/chat/check-message.mjs:7

`Static`pruneData

pruneData(data: any): void
Parameters
- data: any
Returns void
Overrides BaseMessageModel.pruneData
- Defined in module/models/chat/check-message.mjs:16