@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

package/src/foundry/client/apps/hud/hotbar.d.mts

@@ -1,174 +0,0 @@
-import type { GetDataReturnType, MaybePromise, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The global action bar displayed at the bottom of the game view.
-   * The Hotbar is a UI element at the bottom of the screen which contains Macros as interactive buttons.
-   * The Hotbar supports 5 pages of global macros which can be dragged and dropped to organize as you wish.
-   *
-   * Left-clicking a Macro button triggers its effect.
-   * Right-clicking the button displays a context menu of Macro options.
-   * The number keys 1 through 0 activate numbered hotbar slots.
-   * Pressing the delete key while hovering over a Macro will remove it from the bar.
-   *
-   * @see {@link Macros | `Macros`}
-   * @see {@link Macro | `Macro`}
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class Hotbar<Options extends Application.Options = Application.Options> extends Application<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * The currently viewed macro page
-     * @defaultValue `1`
-     */
-    page: number;
-
-    /**
-     * The currently displayed set of macros
-     * @defaultValue `[]`
-     */
-    macros: Macro.Implementation[];
-
-    /**
-     * Track collapsed state
-     * @defaultValue `false`
-     */
-    protected _collapsed: boolean;
-
-    /**
-     * Track which hotbar slot is the current hover target, if any
-     * @defaultValue `null`
-     */
-    protected _hover: number | null;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * mergeObject(super.defaultOptions, {
-     *   id: "hotbar",
-     *   template: "templates/hud/hotbar.html",
-     *   popOut: false,
-     *   dragDrop: [{ dragSelector: ".macro-icon", dropSelector: "#macro-list" }]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): Application.Options;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<Hotbar.HotbarData>>;
-
-    /**
-     * Whether the hotbar is locked.
-     */
-    get locked(): boolean;
-
-    /**
-     * Get the Array of Macro (or null) values that should be displayed on a numbered page of the bar
-     * @param page -
-     */
-    protected _getMacrosByPage(page: number): Macro.Implementation[];
-
-    /**
-     * Collapse the Hotbar, minimizing its display.
-     * @returns A promise which resolves once the collapse animation completes
-     */
-    collapse(): Promise<boolean>;
-
-    /**
-     * Expand the Hotbar, displaying it normally.
-     * @returns A promise which resolves once the expand animation completes
-     */
-    expand(): Promise<boolean>;
-
-    /**
-     * Change to a specific numbered page from 1 to 5
-     * @param page - The page number to change to.
-     *               (default: `1` )
-     */
-    changePage(page?: number): void;
-
-    /**
-     * Change the page of the hotbar by cycling up (positive) or down (negative)
-     * @param direction - The direction to cycle
-     */
-    cyclePage(direction?: number): void;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _contextMenu(html: JQuery): void;
-
-    /**
-     * Get the Macro entry context options
-     * @returns The Macro entry context options
-     * @internal
-     */
-    protected _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    /**
-     * Handle left-click events to
-     * @param event - The originating click event
-     */
-    protected _onClickMacro(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle pagination controls
-     * @param event - The originating click event
-     */
-    protected _onClickPageControl(event: JQuery.ClickEvent): void;
-
-    protected override _canDragStart(selector: string): boolean;
-
-    protected override _onDragStart(event: DragEvent): false | void;
-
-    protected override _canDragDrop(selector: string): boolean;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Create a Macro which rolls a RollTable when executed
-     * @param table - The RollTable document
-     */
-    protected _createRollTableRollMacro(table: RollTable.Implementation): Promise<Macro.Implementation>;
-
-    /**
-     * Create a Macro document which can be used to toggle display of a Journal Entry.
-     * @param doc - A Document which should be toggled
-     * @returns A created Macro document to add to the bar
-     */
-    protected _createDocumentSheetToggle(doc: ClientDocument): Promise<Macro.Implementation>;
-
-    /**
-     * Handle click events to toggle display of the macro bar
-     */
-    protected _onToggleBar(event: JQuery.ClickEvent): void;
-
-    /**
-     * Toggle the hotbar's lock state
-     */
-    protected _toggleHotBarLock(): Promise<this>;
-
-    /**
-     * Handle toggling a document sheet.
-     * @param uuid - The Document UUID to display
-     * @remarks Returns a ui notification number if doc could not be found
-     */
-    static toggleDocumentSheet(uuid: string): Promise<void> | Application.Any | number;
-  }
-
-  namespace Hotbar {
-    interface Any extends AnyHotbar {}
-    interface AnyConstructor extends Identity<typeof AnyHotbar> {}
-
-    interface HotbarData {
-      page: Hotbar["page"];
-      macros: Hotbar["macros"];
-      barClass: "collapsed" | "";
-      locked: boolean;
-    }
-  }
-}
-
-declare abstract class AnyHotbar extends Hotbar {
-  constructor(...args: never);
-}

package/src/foundry/client/apps/hud/hud.d.mts

@@ -1,87 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An abstract base class for displaying a heads-up-display interface bound to a Placeable Object on the canvas
-   * @typeParam Object - the type of the PlaceableObject
-   * @typeParam Options - the type of the options object
-   */
-  abstract class BasePlaceableHUD<
-    Object extends PlaceableObject.Any = PlaceableObject,
-    Options extends Application.Options = Application.Options,
-  > extends Application<Options> {
-    /**
-     * Reference a PlaceableObject this HUD is currently bound to
-     * @defaultValue `undefined`
-     */
-    object: Object | undefined;
-
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["placeable-hud"],
-     *   popOut: false
-     * })
-     * ```
-     */
-    static override get defaultOptions(): Application.Options;
-
-    /**
-     * Convenience access for the canvas layer which this HUD modifies
-     * @remarks Returns undefined only if there's no object
-     */
-    get layer(): Object["layer"];
-
-    /**
-     * Bind the HUD to a new PlaceableObject and display it
-     * @param object - A PlaceableObject instance to which the HUD should be bound
-     */
-    bind(object: Object): void;
-
-    /**
-     * Clear the HUD by fading out it's active HTML and recording the new display state
-     */
-    clear(): void;
-
-    override _render(...args: Parameters<Application<Options>["_render"]>): Promise<void>;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>;
-
-    override setPosition({ left, top, width, height, scale }?: Partial<Application.Position>): void;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle mouse clicks to control a HUD control button
-     * @param event - The originating click event
-     * @remarks This will always return a promise with documents is overridden by TokenHUD.
-     */
-    protected _onClickControl(event: JQuery.ClickEvent): void;
-
-    /**
-     * Toggle the visible state of all controlled objects in the Layer
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onToggleVisibility(event: JQuery.ClickEvent): Promise<Array<Object["document"]>>;
-
-    /**
-     * Toggle locked state of all controlled objects in the Layer
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onToggleLocked(event: JQuery.ClickEvent): Promise<Array<Object["document"]>>;
-
-    /**
-     * Handle sorting the z-order of the object
-     * @param up    - Move the object upwards in the vertical stack?
-     * @param event - The originating mouse click event
-     */
-    protected _onSort(up: boolean, event: JQuery.ClickEvent): Promise<Array<Object["document"]>>;
-  }
-
-  namespace BasePlaceableHUD {
-    interface Any extends BasePlaceableHUD<any, any> {}
-  }
-}

package/src/foundry/client/apps/hud/index.d.mts

@@ -1,9 +0,0 @@
-import "./chatbubble.d.mts";
-import "./container.d.mts";
-import "./controls.d.mts";
-import "./hotbar.d.mts";
-import "./hud.d.mts";
-import "./menu.d.mts";
-import "./navigation.d.mts";
-import "./pause.d.mts";
-import "./players.d.mts";

package/src/foundry/client/apps/hud/menu.d.mts

@@ -1,84 +0,0 @@
-import type { MaybePromise, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The main menu application which is toggled via the ESC key.
-   */
-  class MainMenu extends Application {
-    /**
-     * @defaultValue
-     * ```typescript
-     * return foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "menu",
-     *   template: "templates/hud/menu.html",
-     *   popOut: false
-     * });
-     * ```
-     * */
-    static override get defaultOptions(): Application.Options;
-
-    /**
-     * The structure of menu items
-     * @defaultValue
-     * ```typescript
-     * {
-     *   reload: {
-     *     label: "MENU.Reload",
-     *     icon: "<i class="fas fa-redo"></i>",
-     *     enabled: true,
-     *     onClick: () => window.location.reload()
-     *   },
-     *   logout: {
-     *     label: "MENU.Logout",
-     *     icon: "<i class="fas fa-user"></i>",
-     *     enabled: true,
-     *     onClick: () => game.logOut()
-     *   },
-     *   players: {
-     *     label: "MENU.Players",
-     *     icon: "<i class="fas fa-users"></i>",
-     *     enabled: game.user.isGM && !game.data.demoMode,
-     *     onClick: () => (window.location.href = "./players")
-     *   },
-     *   world: {
-     *     label: "GAME.ReturnSetup",
-     *     icon: "<i class="fas fa-globe"></i>",
-     *     enabled: game.user.hasRole("GAMEMASTER")  && !game.data.demoMode,
-     *     onClick: () => {
-     *       this.close();
-     *       game.shutDown();
-     *     }
-     *   }
-     * }
-     * ```
-     */
-    get items(): MainMenu.MenuStructure;
-
-    override getData(options?: Partial<Application.Options>): MaybePromise<object>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Toggle display of the menu (or render it in the first place)
-     */
-    toggle(): void;
-  }
-
-  namespace MainMenu {
-    interface Any extends AnyMainMenu {}
-    interface AnyConstructor extends Identity<typeof AnyMainMenu> {}
-
-    interface MenuItem {
-      label: string;
-      icon: string;
-      enabled: boolean;
-      onClick: () => void;
-    }
-
-    type MenuStructure = Record<string, MenuItem>;
-  }
-}
-
-declare abstract class AnyMainMenu extends MainMenu {
-  constructor(...args: never);
-}

package/src/foundry/client/apps/hud/navigation.d.mts

@@ -1,121 +0,0 @@
-import type { GetDataReturnType, MaybePromise, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The UI element which displays the Scene documents which are currently enabled for quick navigation.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class SceneNavigation<Options extends Application.Options = Application.Options> extends Application<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * Navigation collapsed state
-     * @internal
-     */
-    protected _collapsed: boolean;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "navigation",
-     *   template: "templates/hud/navigation.html",
-     *   popOut: false,
-     *   dragDrop: [{ dragSelector: ".scene" }],
-     * })
-     * ```
-     */
-    static override get defaultOptions(): Application.Options;
-
-    /**
-     * Return an Array of Scenes which are displayed in the Navigation bar
-     */
-    get scenes(): Scene.Implementation[];
-
-    override render(force?: boolean, context?: Application.RenderOptions<Options>): this;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    override getData(
-      options?: Partial<Application.Options>,
-    ): MaybePromise<GetDataReturnType<SceneNavigation.SceneNavigationData>>;
-
-    /**
-     * Expand the SceneNavigation menu, sliding it down if it is currently collapsed
-     */
-    expand(): Promise<boolean>;
-
-    /**
-     * Collapse the SceneNavigation menu, sliding it up if it is currently expanded
-     */
-    collapse(): Promise<boolean>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Get the set of ContextMenu options which should be applied for Scenes in the menu
-     * @returns The Array of context options passed to the ContextMenu instance
-     * @internal
-     */
-    protected _getContextMenuOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    /**
-     * Handle left-click events on the scenes in the navigation menu
-     * @internal
-     */
-    protected _onClickScene(event: JQuery.ClickEvent): void;
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Handle navigation menu toggle click events
-     * @internal
-     */
-    protected _onToggleNav(event: JQuery.ClickEvent): void;
-
-    /**
-     * Display progress of some major operation like loading Scene textures.
-     * @param options - Options for how the progress bar is displayed
-     */
-    static displayProgressBar(options: SceneNavigation.DisplayProgressBarOptions): void;
-  }
-
-  namespace SceneNavigation {
-    interface Any extends AnySceneNavigation {}
-    interface AnyConstructor extends Identity<typeof AnySceneNavigation> {}
-
-    interface SceneData {
-      id: string;
-      active: boolean;
-      name: string;
-      tooltip: string | null;
-      users: { letter: string; color: User.Implementation["color"] }[];
-      visible: boolean;
-      css: string;
-    }
-
-    interface SceneNavigationData {
-      collapsed: boolean;
-      scenes: SceneData[];
-    }
-
-    interface DisplayProgressBarOptions {
-      /**
-       * A text label to display
-       */
-      label?: string | undefined;
-
-      /**
-       * A percentage of progress between 0 and 100
-       */
-      pct: number;
-    }
-  }
-}
-
-declare abstract class AnySceneNavigation extends SceneNavigation<Application.Options> {
-  constructor(...args: never);
-}

package/src/foundry/client/apps/hud/pause.d.mts

@@ -1,37 +0,0 @@
-import type { GetDataReturnType, MaybePromise, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * Pause notification in the HUD
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class Pause<Options extends Application.Options = Application.Options> extends Application<Options> {
-    /**
-     * @defaultValue
-     * ```ts
-     * const options = super.defaultOptions;
-     * options.id = "pause";
-     * options.template = "templates/hud/pause.html";
-     * options.popOut = false;
-     * return options;
-     * ```
-     */
-    static get defaultOptions(): Application.Options;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<Pause.PauseData>>;
-  }
-
-  namespace Pause {
-    interface Any extends AnyPause {}
-    interface AnyConstructor extends Identity<typeof AnyPause> {}
-
-    interface PauseData {
-      paused: boolean;
-    }
-  }
-}
-
-declare abstract class AnyPause extends Pause<Application.Options> {
-  constructor(...args: never);
-}

package/src/foundry/client/apps/hud/players.d.mts

@@ -1,87 +0,0 @@
-import type { GetDataReturnType, MaybePromise, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The UI element which displays the list of Users who are currently playing within the active World.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class PlayerList<Options extends Application.Options = Application.Options> extends Application<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * An internal toggle for whether to show offline players or hide them
-     * @defaultValue `false`
-     */
-    protected _showOffline: boolean;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "players",
-     *   template: "templates/user/players.html",
-     *   popOut: false
-     * })
-     * ```
-     */
-    static get defaultOptions(): Application.Options;
-
-    /**
-     * Whether the players list is in a configuration where it is hidden
-     */
-    get isHidden(): boolean;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<PlayerList.Data>>;
-
-    /**
-     * Prepare a displayed name string for the User which includes their name, pronouns, character, or GM tag.
-     */
-    protected _getDisplayName(user: User.Implementation): string;
-
-    /**
-     * Position this Application in the main DOM appropriately.
-     */
-    protected _positionInDOM(): void;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Return the default context options available for the Players application
-     */
-    protected _getUserContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    /**
-     * Toggle display of the Players hud setting for whether or not to display offline players
-     * @param event - The originating click event
-     */
-    protected _onToggleOfflinePlayers(event: JQuery.ClickEvent): void;
-  }
-
-  namespace PlayerList {
-    interface Any extends AnyPlayerList {}
-    interface AnyConstructor extends Identity<typeof AnyPlayerList> {}
-
-    interface UserData {
-      active: User.Implementation["active"];
-      isGM: User.Implementation["isGM"];
-      isSelf: User.Implementation["isSelf"];
-      charname: string;
-      color: string;
-      border: string;
-      displayName: string;
-    }
-
-    interface Data {
-      users: UserData[];
-      showOffline: boolean;
-      hide: boolean;
-    }
-  }
-}
-
-declare abstract class AnyPlayerList extends PlayerList<Application.Options> {
-  constructor(...args: never);
-}