@vttforge/core / DocumentSheetOptions

Interface: DocumentSheetOptions

Properties

document

document: SheetDocumentKind

Which document this sheet is for.

---

id

id: string

The id the sheet is filed under, as <namespace>.<id>.

Foundry saves this key on every document whose owner picks the sheet, and builds it from the class name, which a bundler renames between builds. Naming the id here is what keeps the saved key pointing at a sheet that still exists. Pick it once and keep it.

---

label?

optional label?: string

The label shown in the sheet picker, usually a locale key.

---

makeDefault?

optional makeDefault?: boolean

Whether it becomes the default for those types.

---

namespace

namespace: string

The namespace to register under: your system or module id.

---

types?

optional types?: readonly string[]

The subtypes it applies to. Omit for every type.