@vttforge/core / FoundryApplications

Interface: FoundryApplications

foundry.applications.

Properties

api

readonly api: FoundryApplicationsApi

---

apps

readonly apps: FoundryClassNamespace<"DocumentSheetConfig" | "FilePicker" | "ImagePopout">

---

fields

readonly fields: Readonly<Record<string, (...args) => HTMLElement>>

Form input builders: createFormGroup, createSelectInput and the rest.

unknown[], not never[]. A never[] rest parameter accepts no argument at all, so every real call fails with "not assignable to parameter of type 'never'".

---

handlebars

readonly handlebars: object

loadTemplates()

loadTemplates(paths): Promise<unknown>

Warm the template cache, usually in init.

Parameters

paths

readonly string[] | Record<string, string>

Returns

Promise<unknown>

renderTemplate()

renderTemplate(path, context): Promise<string>

Render one template with a context.

Parameters

path

string

context

unknown

Returns

Promise<string>

---

instances

readonly instances: ReadonlyMap<string, object>

Every open application, keyed by its id.

v13 removed ui.windows, and this replaced it. The value is object rather than a shape: a package finds its own window with instanceof, and then it has the class it wrote.

for (const app of foundry.applications.instances.values()) {
  if (app instanceof MyViewer) app.refresh();
}

---

sheets

readonly sheets: FoundryClassNamespace<"ActiveEffectConfig" | "ActorSheetV2" | "ItemSheetV2" | "MacroConfig" | "SceneConfig" | "TokenConfig">

---

ux

readonly ux: Readonly<Record<"ContextMenu" | "DragDrop" | "Draggable" | "FormDataExtended" | "ProseMirrorEditor" | "SearchFilter" | "Tabs", AnyClass>> & Readonly<Record<string, AnyClass | undefined>> & object

Type Declaration

TextEditor

readonly TextEditor: object

TextEditor.implementation

readonly implementation: TextEditorImplementation