@vttforge/types / ActiveEffectConfig

Interface: ActiveEffectConfig

What every CONFIG.<Document> entry carries.

Extends

• DocumentConfig

Properties

changeTypes

changeTypes: Record<string, unknown>

Register a package's own change type here, in init.

---

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

---

expiryAction

expiryAction: "update" | "delete" | null

---

expiryEvents

expiryEvents: Record<string, string>

---

phases

phases: string[]

---

sheetClasses?

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

Inherited from

DocumentConfig.sheetClasses

---

sidebar?

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