@vttforge/types / DocumentConfig

Interface: DocumentConfig<TClass>

What every CONFIG.<Document> entry carries.

Extended by

• ActiveEffectConfig
• ChatMessageConfig
• CombatConfig

Type Parameters

TClass

TClass = DocumentConstructor

Properties

collection?

optional collection?: AnyClass

---

compendiumIndexFields?

optional compendiumIndexFields?: string[]

---

dataModels

dataModels: Record<string, AnyClass>

---

sheetClasses?

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

---

sidebar?

optional sidebar?: object

applicationClass?

optional applicationClass?: AnyClass

order?

optional order?: number

---

typeIcons?

optional typeIcons?: Record<string, string>

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

---

typeLabels?

optional typeLabels?: Record<string, string>

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