Skip to content

@vttforge/types / CombatConfig

Interface: CombatConfig ​

What every CONFIG.<Document> entry carries.

Extends ​

Properties ​

collection? ​

optional collection?: AnyClass

Inherited from ​

DocumentConfig.collection


compendiumIndexFields? ​

optional compendiumIndexFields?: string[]

Inherited from ​

DocumentConfig.compendiumIndexFields


dataModels ​

dataModels: Record<string, AnyClass>

Inherited from ​

DocumentConfig.dataModels


initiative ​

initiative: object

decimals? ​

optional decimals?: number

formula ​

formula: string | null


sheetClasses? ​

optional sheetClasses?: Record<string, Record<string, unknown>>

Inherited from ​

DocumentConfig.sheetClasses


optional sidebar?: object

applicationClass? ​

optional applicationClass?: AnyClass

order? ​

optional order?: number

Inherited from ​

DocumentConfig.sidebar


typeIcons? ​

optional typeIcons?: Record<string, string>

Icon per subtype, shown in the sidebar and on creation dialogs.

Inherited from ​

DocumentConfig.typeIcons


typeLabels? ​

optional typeLabels?: Record<string, string>

Inherited from ​

DocumentConfig.typeLabels

Accessors ​

documentClass ​

Get Signature ​

get documentClass(): TClass

Reading gives the document statics, so CONFIG.Item.documentClass.create() compiles. Writing takes any class, because a system replacing the class rarely declares those statics on its own subclass.

Returns ​

TClass

Set Signature ​

set documentClass(value): void

Parameters ​
value ​

AnyClass

Returns ​

void

Inherited from ​

DocumentConfig.documentClass

MIT licensed.