Skip to content

@vttforge/core / UiApi

Interface: UiApi ​

The ui global. Only the members a package registers against.

Properties ​

activeWindow ​

readonly activeWindow: unknown


actors ​

readonly actors: unknown


chat ​

readonly chat: unknown


combat ​

readonly combat: unknown


compendium ​

readonly compendium: unknown


controls ​

readonly controls: unknown


hotbar ​

readonly hotbar: unknown


items ​

readonly items: unknown


journal ​

readonly journal: unknown


readonly menu: unknown


readonly nav: unknown


notifications ​

readonly notifications: NotificationsApi


players ​

readonly players: unknown


playlists ​

readonly playlists: unknown


scenes ​

readonly scenes: unknown


settings ​

readonly settings: unknown


readonly sidebar: object

expanded ​

readonly expanded: boolean

changeTab() ​

changeTab(tab, group): void

Parameters ​
tab ​

string

group ​

string

Returns ​

void

collapse() ​

collapse(): void

Returns ​

void

expand() ​

expand(): void

Returns ​

void

toggleExpanded() ​

toggleExpanded(expanded?): void

Parameters ​
expanded? ​

boolean

Returns ​

void


tables ​

readonly tables: unknown


windows ​

readonly windows: Record<number, unknown>

MIT licensed.