From 8786e4781d91d2a5ddb9b0d9023273282f487e8e Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Tue, 6 Feb 2024 22:22:33 -0700 Subject: [PATCH] Finish augmenting the Game class --- foundry-augments.d.ts | 79 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/foundry-augments.d.ts b/foundry-augments.d.ts index 7ef9705..9e8815f 100644 --- a/foundry-augments.d.ts +++ b/foundry-augments.d.ts @@ -1,3 +1,82 @@ interface Game { + /** + * The named view which is currently active. + * Game views include: join, setup, players, license, game, stream + */ + readonly view: string; + + /** The object of world data passed from the server */ + readonly data: object; + + /** The Release data for this version of Foundry */ + readonly release: config.ReleaseData; + + /** The id of the active World user, if any */ + readonly userId: string | null; + + /** A mapping of WorldCollection instances, one per primary Document type. */ + readonly collections: Collection + + /** A mapping of CompendiumCollection instances, one per Compendium pack. */ + readonly packs: CompendiumPacks; + + /** A singleton web Worker manager. */ + readonly workers: WorkerManager; + + /** Localization support */ + readonly i18n: Localization; + + /** The Keyboard Manager */ + readonly keyboard: KeyboardManager; + + /** The Mouse Manager */ + readonly mouse: MouseManager; + + /** The Gamepad Manager */ + readonly gamepad: GamepadManager; + + /** The New User Experience manager. */ + readonly nue: NewUserExperience; + + /** The client session id which is currently active */ + readonly sessionId: string; + + /** Client settings which are used to configure application behavior */ readonly settings: ClientSettings; + + /** Client keybindings which are used to configure application behavior */ + readonly keybindings: ClientKeybindings; + + /** A reference to the open Socket.io connection */ + readonly socket: WebSocket | null; + + /** + * A singleton GameTime instance which manages the progression of time within + * the game world. + */ + readonly time: GameTime; + + /** A singleton reference to the Canvas object which may be used. */ + readonly canvas: Canvas; + + /** A singleton instance of the Audio Helper class */ + readonly audio: AudioHelper; + + /** A singleton instance of the Video Helper class */ + readonly video: VideoHelper; + + /** A singleton instance of the TooltipManager class. */ + readonly tooltip: TooltipManager; + + /** A singleton instance of the Clipboard Helper class. */ + readonly clipboard: ClipboardHelper; + + /** A singleton instance of the Tour collection class */ + readonly tours: Tours; + + /** The global document index. */ + readonly documentIndex: DocumentIndex; + + /** The singleton instance of the ClientIssues manager. */ + readonly issues: ClientIssues; }