Skip to content

@vttforge/core / SheetBaseCtor

Interface: SheetBaseCtor<TDocument> ​

The statics a VTTForge sheet base carries.

The factory used to return a bare constructor, so a subclass writing super.DEFAULT_OPTIONS (the pattern the docs show and every sheet needs) failed to compile. TypeScript cannot see a static through an untyped constructor. The example system never caught it because it is JavaScript.

DEFAULT_OPTIONS is deliberately loose: a subclass merges its own shape into it, and pinning ours would reject the merge.

Extends ​

Type Parameters ​

TDocument ​

TDocument = ActorLike

Constructors ​

Constructor ​

new SheetBaseCtor(...args): SheetBaseMembers & DocumentSheetV2Members<TDocument>

Parameters ​

args ​

...any[]

Returns ​

SheetBaseMembers & DocumentSheetV2Members<TDocument>

Inherited from ​

SheetBaseStatics.constructor

Properties ​

DEFAULT_OPTIONS ​

readonly DEFAULT_OPTIONS: Record<string, any>

Inherited from ​

SheetBaseStatics.DEFAULT_OPTIONS


DRAG_DROP ​

readonly DRAG_DROP: readonly DragDropConfig[]

Inherited from ​

SheetBaseStatics.DRAG_DROP


MODES? ​

readonly optional MODES?: SheetModesConfig

Opt into play and edit modes. Absent, the sheet is always in edit and shows no toggle. See sheet-modes.ts for what the opt-in gives.

Inherited from ​

SheetBaseStatics.MODES

MIT licensed.