Skip to content

@vttforge/core / ApplicationV2Members

Interface: ApplicationV2Members

The ApplicationV2 surface these bases rely on.

Deliberately small. Every member here is one a real consumer used, not one that exists in Foundry. The point is to describe what the factories stand on, not to restate Foundry's API.

Extended by

Properties

element

readonly element: HTMLElement | undefined

The window's root element once rendered. undefined before that.


options

readonly options: Record<string, unknown>

The resolved options this instance was constructed with.


rendered

readonly rendered: boolean

Whether the window is currently rendered.


title

readonly title: string

The window title, from options.window.title.

Methods

_onFirstRender()

_onFirstRender(context, options): void

Runs after the first render only.

Parameters

context

unknown

options

unknown

Returns

void


_onRender()

_onRender(context, options): void

Runs after every render.

Parameters

context

unknown

options

unknown

Returns

void


_prepareContext()

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

Build the render context.

Parameters

options

unknown

Returns

Promise<Record<string, unknown>>


close()

close(options?): Promise<unknown>

Close the window.

Parameters

options?

unknown

Returns

Promise<unknown>


render()

render(options?, _options?): Promise<unknown>

Render the application. Resolves when the render completes.

Parameters

options?

unknown

_options?

unknown

Returns

Promise<unknown>

MIT licensed.