@vttforge/types / 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 ​
readonlyelement:HTMLElement|undefined
The window's root element once rendered. undefined before that.
options ​
readonlyoptions:ApplicationConfiguration
The resolved options this instance was constructed with.
rendered ​
readonlyrendered:boolean
Whether the window is currently rendered.
title ​
readonlytitle:string
The window title, from options.window.title.
Methods ​
_onFirstRender() ​
_onFirstRender(
context,options):void
Runs after the first render only.
Parameters ​
context ​
options ​
Returns ​
void
_onRender() ​
_onRender(
context,options):void
Runs after every render.
Parameters ​
context ​
options ​
Returns ​
void
_prepareContext() ​
_prepareContext(
options):Promise<ApplicationRenderContext>
Build the render context.
Parameters ​
options ​
Returns ​
Promise<ApplicationRenderContext>
_preRender() ​
_preRender(
context,options):Promise<void>
Runs after _prepareContext and before the frame renders. New in v14.
Parameters ​
context ​
options ​
Returns ​
Promise<void>
attachWindow() ​
attachWindow():
void
Returns ​
void
close() ​
close(
options?):Promise<ApplicationV2Members>
Close the window.
Parameters ​
options? ​
Record<string, unknown>
Returns ​
Promise<ApplicationV2Members>
detachWindow() ​
detachWindow():
void
Move the window into its own browser window. New in v14.
Returns ​
void
render() ​
render(
options?,_options?):Promise<ApplicationV2Members>
Render the application. Resolves when the render completes.
Parameters ​
options? ​
boolean | ApplicationRenderOptions
_options? ​
Returns ​
Promise<ApplicationV2Members>