Skip to content

@vttforge/core / SheetBaseMembers

Interface: SheetBaseMembers

What the sheet factories add on top of Foundry's own sheet.

Only the members a subclass actually reaches for. The rest of the Foundry surface stays reachable and untyped until @vttforge/types describes it; see DocumentSheetV2Members.

Methods

_onDragStart()

_onDragStart(event): void

Parameters

event

DragEvent

Returns

void


_onDropActiveEffect()

_onDropActiveEffect(event, data): Promise<unknown>

Parameters

event

DragEvent

data

unknown

Returns

Promise<unknown>


_onDropActor()

_onDropActor(event, data): Promise<unknown>

Parameters

event

DragEvent

data

unknown

Returns

Promise<unknown>


_onDropFolder()

_onDropFolder(event, data): Promise<unknown>

Parameters

event

DragEvent

data

unknown

Returns

Promise<unknown>


_onDropItem()

_onDropItem(event, data): Promise<unknown>

Foundry's own drop entry points, implemented here to resolve the payload and hand it to the onDropX hook above.

Declared because the base really does define them. An earlier version left them off, and nothing said so while an index signature was making every member name legal. Override onDropItem rather than this.

Parameters

event

DragEvent

data

unknown

Returns

Promise<unknown>


_onRender()

_onRender(context, options): void

Binds the static DRAG_DROP entries.

Parameters

context

unknown

options

unknown

Returns

void


_prepareContext()

_prepareContext(options): Promise<Record<string, unknown>>

Fills in context.tabs for every group in static TABS.

Parameters

options

unknown

Returns

Promise<Record<string, unknown>>


onDropActiveEffect()

onDropActiveEffect(effect, event): Promise<unknown>

Parameters

effect

unknown

event

DragEvent

Returns

Promise<unknown>


onDropActor()

onDropActor(actor, event): Promise<unknown>

Parameters

actor

unknown

event

DragEvent

Returns

Promise<unknown>


onDropFolder()

onDropFolder(folder, event): Promise<unknown>

Parameters

folder

unknown

event

DragEvent

Returns

Promise<unknown>


onDropItem()

onDropItem(item, event): Promise<unknown>

The typed drop hooks. Override the one you want; returning undefined hands the drop back to Foundry's own handling.

Parameters

item

unknown

event

DragEvent

Returns

Promise<unknown>

MIT licensed.