VTTForge

Appearance

@vttforge/types / Game

Interface: Game ​

The game global.

game.user is null during init. Read it from ready onwards.

Properties ​

activeTool ​

readonly activeTool: string

actors ​

readonly actors: WorldCollection<ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>>>

audio ​

readonly audio: unknown

cards ​

readonly cards: WorldCollection<DocumentMembers<Record<string, unknown>>>

combat ​

readonly combat: CombatLike<Record<string, unknown>> | null

The active encounter, or null when none is running.

combats ​

readonly combats: WorldCollection<CombatLike<Record<string, unknown>>>

data ​

readonly data: Record<string, unknown>

documentTypes ​

readonly documentTypes: Record<string, string[]>

folders ​

readonly folders: WorldCollection<FolderLikeDocument>

i18n ​

readonly i18n: LocalizationApi

isAdmin ​

readonly isAdmin: boolean

items ​

readonly items: WorldCollection<ItemLike<Record<string, unknown>>>

journal ​

readonly journal: WorldCollection<JournalEntryLike>

keybindings ​

readonly keybindings: KeybindingsApi

keyboard ​

readonly keyboard: KeyboardApi

macros ​

readonly macros: WorldCollection<MacroLike>

messages ​

readonly messages: WorldCollection<ChatMessageLike<Record<string, unknown>>>

model ​

readonly model: Record<string, Record<string, unknown>>

Type defaults, the replacement for the removed game.template.

modules ​

readonly modules: FoundryCollection<PackageHandle>

packs ​

readonly packs: FoundryCollection<CompendiumCollection>

paused ​

readonly paused: boolean

permissions ​

readonly permissions: Record<string, readonly number[]>

playlists ​

readonly playlists: WorldCollection<DocumentMembers<Record<string, unknown>>>

ready ​

readonly ready: boolean

release ​

readonly release: object

build ​

build: number

generation ​

generation: number

version ​

version: string

scenes ​

readonly scenes: WorldCollection<SceneLike<Record<string, unknown>>>

settings ​

readonly settings: GameSettingsApi

socket ​

readonly socket: SocketApi | null

system ​

readonly system: SystemHandle

tables ​

readonly tables: WorldCollection<DocumentMembers<Record<string, unknown>>>

time ​

readonly time: GameTimeApi

tours ​

readonly tours: FoundryCollection<unknown>

user ​

readonly user: UserLike | null

userId ​

readonly userId: string | null

users ​

readonly users: WorldCollection<UserLike>

version ​

readonly version: string

video ​

readonly video: unknown

view ​

readonly view: string

world ​

readonly world: WorldHandle

MIT licensed.

Not affiliated with Foundry Gaming LLC or with The Forge hosting service.