@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

package/src/foundry/client/head.d.mts

@@ -0,0 +1,86 @@
+import type { EarlierEvents, InitializationEvent } from "./game.d.mts";
+
+type ValidRanHooks = Extract<keyof AssumeHookRan, InitializationEvent>;
+
+type _UninitializedGame = { [K in keyof Game]?: never };
+
+interface UninitializedGame extends _UninitializedGame {}
+
+// These type aliases are used for intellisense reasons so that the type displays `UninitializedGame | InitGame | ...` instead of a too complex looking type.
+interface Games {
+  none: UninitializedGame;
+  init: InitGame;
+  i18nInit: I18nInitGame;
+  setup: SetupGame;
+  ready: ReadyGame;
+}
+
+// Needs to include the current hook as well as all hooks that can run after it.
+type GameHooks = Exclude<InitializationEvent, EarlierEvents[keyof AssumeHookRan]>;
+
+type MaybeUI = Extract<keyof AssumeHookRan, "ready"> extends never ? Partial<UiApplications> : UiApplications;
+
+declare global {
+  /**
+   * The string prefix used to prepend console logging
+   */
+  const vtt: "Foundry VTT";
+
+  /**
+   * The singleton Game instance
+   * @defaultValue `{}`
+   * @remarks
+   * Initialized just before the `"init"` hook event.
+   */
+  let game: Games[GameHooks];
+
+  /**
+   * The global boolean for whether the EULA is signed
+   */
+  let SIGNED_EULA: boolean;
+
+  /**
+   * The global route prefix which is applied to this game
+   */
+  let ROUTE_PREFIX: string;
+
+  /**
+   * Critical server-side startup messages which need to be displayed to the client.
+   */
+  let MESSAGES:
+    | { type: Notifications.Notification["type"]; message: string; options: Notifications.NotifyOptions }[]
+    | null;
+
+  /**
+   * A collection of application instances
+   * @remarks
+   * - All of the elements of {@link ui} except for `context` and `window` are initialized between the `"setup"` and `"ready"` hook events.
+   * - In the `/stream` view, only `chat` is initialized but none of the other {@link Application}s.
+   */
+  let ui: {
+    /**
+     * @remarks
+     * Initialized whenever a {@link ContextMenu} is opened, deleted when it's closed again.
+     */
+    context?: ContextMenu;
+
+    /**
+     * @defaultValue `{}`
+     */
+    windows: Record<number, Application>;
+  } & MaybeUI;
+
+  /**
+   * The client side console logger
+   */
+  let logger: typeof console;
+
+  /**
+   * The Color management and manipulation class
+   */
+  export import Color = foundry.utils.Color;
+}
+
+type UiApplications = {
+  [Key in keyof CONFIG["ui"]]: InstanceType<CONFIG["ui"][Key]>;
+};