@vttforge/types / FoundryConfig

Interface: FoundryConfig

The CONFIG global.

The document entries and the ones a package writes in init are named. The index signature carries the rest of Foundry's own CONFIG, which is large and mostly canvas internals.

Indexable

[key: string]: unknown

Properties

ActiveEffect

ActiveEffect: ActiveEffectConfig

---

Actor

Actor: DocumentConfig

---

Canvas

Canvas: object

Index Signature

[key: string]: unknown

layers

layers: Record<string, { group: string; layerClass: AnyClass; }>

---

Cards

Cards: DocumentConfig

---

ChatMessage

ChatMessage: ChatMessageConfig

---

Combat

Combat: CombatConfig

---

Combatant

Combatant: DocumentConfig

---

debug

debug: object

Index Signature

[key: string]: unknown

hooks?

optional hooks?: boolean

---

Dice

Dice: DiceConfig

---

Folder

Folder: DocumentConfig

---

Item

Item: DocumentConfig

---

JournalEntry

JournalEntry: DocumentConfig

---

JournalEntryPage

JournalEntryPage: DocumentConfig

---

Macro

Macro: DocumentConfig

---

Playlist

Playlist: DocumentConfig

---

queries

queries: QueryHandlers

---

RollTable

RollTable: DocumentConfig

---

Scene

Scene: DocumentConfig

---

specialStatusEffects

specialStatusEffects: Record<string, string>

---

statusEffects

statusEffects: Record<string, StatusEffectConfig>

A Proxy indexed by status id since v14. Assign by id, never by push.

---

TextEditor

TextEditor: TextEditorConfig

---

Token

Token: DocumentConfig<AnyClass> & object

Type Declaration

barConfig?

optional barConfig?: Record<string, unknown>

objectClass?

optional objectClass?: AnyClass

---

User

User: DocumentConfig