@league-of-foundry-developers/foundry-vtt-types 9.249.3 → 9.255.1

package/src/foundry/foundry.js/clientSettings.d.ts

@@ -1,249 +1,222 @@
-/**
- * A class responsible for managing defined game settings or settings menus.
- * Each setting is a string key/value pair belonging to a certain package and a certain store scope.
- *
- * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
- * Game object as as game.settings.
- *
- * @see {@link Game#settings}
- * @see {@link Settings}
- * @see {@link SettingsConfig}
- */
-declare class ClientSettings {
-  constructor(worldSettings?: Setting['data']['_source'][]);
+import type { DocumentSubTypes, DocumentType } from '../../types/helperTypes';
 
-  /**
-   * A object of registered game settings for this scope
-   */
-  settings: Map<string, ClientSettings.CompleteSetting>;
+import type { TokenDataSource } from '../common/data/data.mjs/tokenData';
 
+declare global {
   /**
-   * Registered settings menus which trigger secondary applications
+   * A class responsible for managing defined game settings or settings menus.
+   * Each setting is a string key/value pair belonging to a certain package and a certain store scope.
+   *
+   * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
+   * Game object as as game.settings.
+   *
+   * @see {@link Game#settings}
+   * @see {@link Settings}
+   * @see {@link SettingsConfig}
    */
-  menus: Map<string, ClientSettings.CompleteMenuSetting>;
+  class ClientSettings {
+    constructor(worldSettings?: Setting['data']['_source'][]);
 
-  /**
-   * The storage interfaces used for persisting settings
-   * Each storage interface shares the same API as window.localStorage
-   * @remarks This is a lie, it doesn't actually have the same interface...
-   */
-  storage: Map<string, Storage | WorldSettings>;
+    /**
+     * A object of registered game settings for this scope
+     */
+    settings: Map<string, SettingConfig>;
 
-  /**
-   * The types of settings which should be constructed as a primitive type
-   */
-  protected static PRIMITIVE_TYPES: [typeof String, typeof Number, typeof Boolean, typeof Array];
+    /**
+     * Registered settings menus which trigger secondary applications
+     */
+    menus: Map<string, SettingSubmenuConfig>;
 
-  /**
-   * Return a singleton instance of the Game Settings Configuration app
-   */
-  get sheet(): SettingsConfig;
+    /**
+     * The storage interfaces used for persisting settings
+     * Each storage interface shares the same API as window.localStorage
+     * @remarks This is a lie, it doesn't actually have the same interface...
+     */
+    storage: Map<string, Storage | WorldSettings>;
 
-  /**
-   * Register a new game setting under this setting scope
-   *
-   * @param module - The namespace under which the setting is registered
-   * @param key    - The key name for the setting under the namespace module
-   * @param data   - Configuration for setting data
-   * @typeParam M  - The module name to register the setting for
-   * @typeParam K  - The key to register the setting for
-   * @typeParam T  - The type of the setting value
-   *
-   * @example
-   * ```typescript
-   * // Register a client setting
-   * game.settings.register("myModule", "myClientSetting", {
-   *   name: "Register a Module Setting with Choices",
-   *   hint: "A description of the registered setting and its behavior.",
-   *   scope: "client",     // This specifies a client-stored setting
-   *   config: true,        // This specifies that the setting appears in the configuration view
-   *   type: String,
-   *   choices: {           // If choices are defined, the resulting setting will be a select menu
-   *     "a": "Option A",
-   *     "b": "Option B"
-   *   },
-   *   default: "a",        // The default value for the setting
-   *   onChange: value => { // A callback function which triggers when the setting is changed
-   *     console.log(value)
-   *   }
-   * });
-   * ```
-   *
-   * @example
-   * ```typescript
-   * // Register a world setting
-   * game.settings.register("myModule", "myWorldSetting", {
-   *   name: "Register a Module Setting with a Range slider",
-   *   hint: "A description of the registered setting and its behavior.",
-   *   scope: "world",      // This specifies a world-level setting
-   *   config: true,        // This specifies that the setting appears in the configuration view
-   *   type: Number,
-   *   range: {             // If range is specified, the resulting setting will be a range slider
-   *     min: 0,
-   *     max: 100,
-   *     step: 10
-   *   }
-   *   default: 50,         // The default value for the setting
-   *   onChange: value => { // A callback function which triggers when the setting is changed
-   *     console.log(value)
-   *   }
-   * });
-   * ```
-   */
-  register<M extends string, K extends string, T>(
-    module: M,
-    key: K,
-    data: ClientSettings.Values[`${M}.${K}`] extends boolean | number | bigint | string | symbol | object
-      ? ClientSettings.PartialSetting<ClientSettings.Values[`${M}.${K}`]>
-      : ClientSettings.PartialSetting<T>
-  ): void;
+    /**
+     * The types of settings which should be constructed as a primitive type
+     */
+    protected static PRIMITIVE_TYPES: [typeof String, typeof Number, typeof Boolean, typeof Array];
 
-  /**
-   * Register a new sub-settings menu
-   *
-   * @param module - The namespace under which the menu is registered
-   * @param key    - The key name for the setting under the namespace module
-   * @param data   - Configuration for setting data
-   * @typeParam M  - The module name to register the menu setting for
-   * @typeParam K  - The key to register the menu setting for
-   *
-   * @example
-   * ```typescript
-   * // Define a settings submenu which handles advanced configuration needs
-   * game.settings.registerMenu("myModule", "mySettingsMenu", {
-   *   name: "My Settings Submenu",
-   *   label: "Settings Menu Label",      // The text label used in the button
-   *   hint: "A description of what will occur in the submenu dialog.",
-   *   icon: "fas fa-bars",               // A Font Awesome icon used in the submenu button
-   *   type: MySubmenuApplicationClass,   // A FormApplication subclass which should be created
-   *   restricted: true                   // Restrict this submenu to gamemaster only?
-   * });
-   * ```
-   */
-  registerMenu<M extends string, K extends string>(
-    module: M,
-    key: K,
-    data: ClientSettings.RegisteredMenuSettings[`${M}.${K}`]
-  ): void;
-
-  /**
-   * Get the value of a game setting for a certain module and setting key
-   *
-   * @param module - The module namespace under which the setting is registered
-   * @param key    - The setting key to retrieve
-   * @typeParam M  - The module name to register the get for
-   * @typeParam K  - The key to get the setting for
-   *
-   * @example
-   * ```typescript
-   * // Retrieve the current setting value
-   * game.settings.get("myModule", "myClientSetting");
-   * ```
-   */
-  get<M extends string, K extends string>(module: M, key: K): ClientSettings.Values[`${M}.${K}`];
+    /**
+     * Return a singleton instance of the Game Settings Configuration app
+     */
+    get sheet(): SettingsConfig;
 
-  /**
-   * Set the value of a game setting for a certain module and setting key
-   *
-   * @param module - The module namespace under which the setting is registered
-   * @param key    - The setting key to retrieve
-   * @param value  - The data to assign to the setting key
-   * @typeParam M  - The module name to register the get for
-   * @typeParam K  - The key to get the setting for
-   * @typeParam V  - The value type to get the value for
-   *
-   * @example
-   * ```typescript
-   * // Update the current value of a setting
-   * game.settings.set("myModule", "myClientSetting", "b");
-   * ```
-   */
-  set<M extends string, K extends string, V extends ClientSettings.Values[`${M}.${K}`]>(
-    module: M,
-    key: K,
-    value: V
-  ): Promise<V>;
-}
+    /**
+     * Register a new game setting under this setting scope
+     *
+     * @param namespace - The namespace under which the setting is registered
+     * @param key       - The key name for the setting under the namespace module
+     * @param data      - Configuration for setting data
+     * @typeParam N     - The namespace under which the setting is registered, as a type
+     * @typeParam K     - The key name for the setting under the namespace module, as a type
+     * @typeParam T     - The type of the setting value
+     *
+     * @example
+     * ```typescript
+     * // Register a client setting
+     * game.settings.register("myModule", "myClientSetting", {
+     *   name: "Register a Module Setting with Choices",
+     *   hint: "A description of the registered setting and its behavior.",
+     *   scope: "client",     // This specifies a client-stored setting
+     *   config: true,        // This specifies that the setting appears in the configuration view
+     *   type: String,
+     *   choices: {           // If choices are defined, the resulting setting will be a select menu
+     *     "a": "Option A",
+     *     "b": "Option B"
+     *   },
+     *   default: "a",        // The default value for the setting
+     *   onChange: value => { // A callback function which triggers when the setting is changed
+     *     console.log(value)
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Register a world setting
+     * game.settings.register("myModule", "myWorldSetting", {
+     *   name: "Register a Module Setting with a Range slider",
+     *   hint: "A description of the registered setting and its behavior.",
+     *   scope: "world",      // This specifies a world-level setting
+     *   config: true,        // This specifies that the setting appears in the configuration view
+     *   type: Number,
+     *   range: {             // If range is specified, the resulting setting will be a range slider
+     *     min: 0,
+     *     max: 100,
+     *     step: 10
+     *   }
+     *   default: 50,         // The default value for the setting
+     *   onChange: value => { // A callback function which triggers when the setting is changed
+     *     console.log(value)
+     *   }
+     * });
+     * ```
+     */
+    register<N extends string, K extends string, T>(
+      namespace: N,
+      key: K,
+      data: ClientSettings.Values[`${N}.${K}`] extends string | number | boolean | Array<any> | object
+        ? ClientSettings.PartialSettingConfig<ClientSettings.Values[`${N}.${K}`]>
+        : ClientSettings.PartialSettingConfig<T>
+    ): void;
 
-declare namespace ClientSettings {
-  interface CompleteSetting<T = unknown> extends PartialSetting<T> {
-    key: string;
-    module: string;
-  }
+    /**
+     * Register a new sub-settings menu
+     *
+     * @param namespace - The namespace under which the menu is registered
+     * @param key       - The key name for the setting under the namespace module
+     * @param data      - Configuration for setting data
+     * @typeParam N     - The namespace under which the menu is registered, as a type
+     * @typeParam K     - The key name for the setting under the namespace module, as a type
+     *
+     * @example
+     * ```typescript
+     * // Define a settings submenu which handles advanced configuration needs
+     * game.settings.registerMenu("myModule", "mySettingsMenu", {
+     *   name: "My Settings Submenu",
+     *   label: "Settings Menu Label",      // The text label used in the button
+     *   hint: "A description of what will occur in the submenu dialog.",
+     *   icon: "fas fa-bars",               // A Font Awesome icon used in the submenu button
+     *   type: MySubmenuApplicationClass,   // A FormApplication subclass which should be created
+     *   restricted: true                   // Restrict this submenu to gamemaster only?
+     * });
+     * ```
+     */
+    registerMenu<N extends string, K extends string>(
+      namespace: N,
+      key: K,
+      data: ClientSettings.PartialSettingSubmenuConfig
+    ): void;
 
-  interface CompleteMenuSetting extends PartialMenuSetting {
-    key: string;
-    module: string;
-  }
+    /**
+     * Get the value of a game setting for a certain namespace and setting key
+     *
+     * @param namespace - The namespace under which the setting is registered
+     * @param key       - The setting key to retrieve
+     * @typeParam N     - The namespace under which the setting is registered, as a type
+     * @typeParam K     - The setting key to retrieve, as a type
+     *
+     * @example
+     * ```typescript
+     * // Retrieve the current setting value
+     * game.settings.get("myModule", "myClientSetting");
+     * ```
+     */
+    get<N extends string, K extends string>(namespace: N, key: K): ClientSettings.Values[`${N}.${K}`];
 
-  interface PartialSetting<T = unknown> {
-    choices?: Record<string, string>;
-    config?: boolean;
-    default?: T;
-    hint?: string;
-    name?: string;
-    onChange?: (value: T) => void;
-    range?: T extends number
-      ? {
-          max: number;
-          min: number;
-          step: number;
-        }
-      : undefined;
-    filePicker?: T extends string ? true | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder' : undefined;
-    scope: string;
-    type?: T extends boolean
-      ? typeof Boolean
-      : T extends number
-      ? typeof Number
-      : T extends bigint
-      ? typeof BigInt
-      : T extends string
-      ? typeof String
-      : T extends symbol
-      ? typeof Symbol
-      : ConstructorOf<T>;
+    /**
+     * Set the value of a game setting for a certain namespace and setting key
+     *
+     * @param namespace - The namespace under which the setting is registered
+     * @param key       - The setting key to retrieve
+     * @param value     - The data to assign to the setting key
+     * @typeParam N     - The namespace under which the setting is registered, as a type
+     * @typeParam K     - The setting key to retrieve, as a type
+     * @typeParam V     - The type of the value being set
+     *
+     * @example
+     * ```typescript
+     * // Update the current value of a setting
+     * game.settings.set("myModule", "myClientSetting", "b");
+     * ```
+     */
+    set<N extends string, K extends string, V extends ClientSettings.Values[`${N}.${K}`]>(
+      namespace: N,
+      key: K,
+      value: V
+    ): Promise<V>;
   }
 
-  interface PartialMenuSetting {
-    hint?: string;
-    icon?: string;
-    label?: string;
-    name?: string;
-    restricted: boolean;
-    type: ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
-  }
+  namespace ClientSettings {
+    type PartialSettingConfig<T = unknown> = InexactPartial<Omit<SettingConfig<T>, 'key' | 'namespace'>>;
 
-  interface RegisteredMenuSettings {
-    [key: string]: PartialMenuSetting;
-  }
+    type PartialSettingSubmenuConfig = Omit<SettingSubmenuConfig, 'key' | 'namespace'>;
 
-  interface Values {
-    'core.animateRollTable': boolean;
-    'core.chatBubbles': boolean;
-    'core.chatBubblesPan': boolean;
-    'core.combatTrackerConfig': { resource: string; skipDefeated: boolean } | {};
-    'core.compendiumConfiguration': Partial<Record<string, CompendiumCollection.Configuration>>;
-    'core.coneTemplateType': 'round' | 'flat';
-    'core.defaultDrawingConfig': foundry.data.DrawingData['_source'] | {};
-    'core.globalAmbientVolume': number;
-    'core.globalInterfaceVolume': number;
-    'core.globalPlaylistVolume': number;
-    'core.keybindings': Record<string, KeybindingActionBinding[]>;
-    'core.language': string;
-    'core.leftClickRelease': boolean;
-    'core.lightAnimation': boolean;
-    'core.maxFPS': number;
-    'core.mipmap': boolean;
-    'core.moduleConfiguration': Record<string, boolean>;
-    'core.nue.shownTips': boolean;
-    'core.noCanvas': boolean;
-    'core.permissions': Game.Permissions;
-    'core.rollMode': keyof CONFIG.Dice.RollModes;
-    'core.softShadows': boolean;
-    'core.time': number;
-    'core.tokenDragPreview': boolean;
-    'core.visionAnimation': boolean;
-    [key: string]: unknown;
+    interface Values {
+      'core.animateRollTable': boolean;
+      'core.chatBubbles': boolean;
+      'core.chatBubblesPan': boolean;
+      'core.combatTrackerConfig': { resource: string; skipDefeated: boolean } | {};
+      'core.compendiumConfiguration': Partial<Record<string, CompendiumCollection.Configuration>>;
+      'core.coneTemplateType': 'round' | 'flat';
+      'core.defaultDrawingConfig': foundry.data.DrawingData['_source'] | {};
+      'core.defaultToken': DeepPartial<TokenDataSource>;
+      'core.disableResolutionScaling': boolean;
+      'core.fontSize': number;
+      'core.fpsMeter': boolean;
+      'core.globalAmbientVolume': number;
+      'core.globalInterfaceVolume': number;
+      'core.globalPlaylistVolume': number;
+      'core.keybindings': Record<string, KeybindingActionBinding[]>;
+      'core.language': string;
+      'core.leftClickRelease': boolean;
+      'core.lightAnimation': boolean;
+      'core.maxFPS': number;
+      'core.mipmap': boolean;
+      'core.moduleConfiguration': Record<string, boolean>;
+      'core.noCanvas': boolean;
+      'core.notesDisplayToggle': boolean;
+      'core.nue.shownTips': boolean;
+      'core.performanceMode': boolean;
+      'core.permissions': Game.Permissions;
+      'core.playlist.playingLocation': 'top' | 'bottom';
+      'core.rollMode': keyof CONFIG.Dice.RollModes;
+      'core.rtcClientSettings': typeof AVSettings.DEFAULT_CLIENT_SETTINGS;
+      'core.rtcWorldSettings': typeof AVSettings.DEFAULT_WORLD_SETTINGS;
+      'core.scrollingStatusText': boolean;
+      'core.sheetClasses': {
+        [Key in DocumentType as DocumentSubTypes<Key> extends string ? Key : never]?: Record<
+          DocumentSubTypes<Key> & string,
+          string
+        >;
+      };
+      'core.time': number;
+      'core.tokenDragPreview': boolean;
+      'core.visionAnimation': boolean;
+      [key: string]: unknown;
+    }
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts

@@ -164,7 +164,9 @@ declare global {
      * Provide a dialog form that prompts the user to import the full contents of a Compendium pack into the World.
      * @param options - Additional options passed to the Dialog.confirm method
      *                  (default: `{}`)
-     * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
+     * @returns A promise which resolves in the following ways: an array of imported
+     *          Documents if the "yes" button was pressed, false if the "no" button was pressed, or
+     *          null if the dialog was closed without making a choice.
      */
     importDialog(
       options?: Dialog.Options | undefined

package/src/foundry/foundry.js/config.d.ts

@@ -382,6 +382,9 @@ declare global {
 
       /** @defaultValue `Folders` */
       collection: ConstructorOf<Folders>;
+
+      /** @defaultValue `'fas fa-folder'` */
+      sidebarIcon: string;
     };
 
     /**

package/src/foundry/foundry.js/game.d.ts

@@ -524,7 +524,7 @@ declare global {
         private: boolean;
         system?: string;
         type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-      };
+      }[];
       scripts: string[];
       styles: string[];
       type: 'world' | 'system' | 'module';

package/src/foundry/foundry.js/gamepadManager.d.ts

@@ -2,6 +2,18 @@
 declare class GamepadManager {
   constructor();
 
+  /**
+   * @defaultValue `null`
+   * @internal
+   */
+  protected _gamepadPoller: number | null;
+
+  /**
+   * The connected Gamepads
+   * @internal
+   */
+  protected _connectedGamepads: Map<string, ConnectedGamepad>;
+
   /**
    * How often Gamepad polling should check for button presses
    * @defaultValue `100`

package/src/foundry/foundry.js/globalVariables.d.ts

@@ -70,37 +70,6 @@ declare global {
   /** The client-side console is the default logger  */
   let logger: typeof console;
 
-  /**
-   * @deprecated since 0.8.0
-   * You are referencing the FEATURES object which has been deprecated as it is no longer an agreed-upon method for how to track evolution of the Foundry Virtual Tabletop API. Discussion about alternate approaches is actively ongoing within the League of Developers community. For the time being the recommendation is to test against game.data.version to understand the current Foundry VTT version which is active. The FEATURES object will be removed in 0.9.0.
-   */
-  let FEATURES: {
-    readonly ACTIVE_EFFECTS: 2;
-    readonly ACTORS: 3;
-    readonly AUDIO_VIDEO: 2;
-    readonly CHAT: 3;
-    readonly COMBAT: 3;
-    readonly COMPENDIUM: 3;
-    readonly DICE: 2;
-    readonly DRAWINGS: 3;
-    readonly ENTITIES: 5;
-    readonly GRID: 2;
-    readonly ITEMS: 3;
-    readonly JOURNAL: 2;
-    readonly LIGHTING: 3;
-    readonly LOCALIZATION: 2;
-    readonly MACROS: 2;
-    readonly NOTES: 2;
-    readonly PLAYLISTS: 2;
-    readonly ROLL_TABLES: 2;
-    readonly SETTINGS: 3;
-    readonly SOUND: 2;
-    readonly TEMPLATES: 2;
-    readonly TILES: 3;
-    readonly TOKENS: 4;
-    readonly WALLS: 3;
-  };
-
   /**
    * @defaultValue `undefined`
    * Initialized between the `'DOMContentLoaded'` event and the `'init'` hook event.

package/src/foundry/foundry.js/pixi/containers/baseGrid.d.ts

@@ -22,7 +22,12 @@ declare class BaseGrid extends PIXI.Container {
    */
   highlight: PIXI.Container;
 
-  draw(): this;
+  /**
+   * Draw the grid. Subclasses are expected to override this method to perform their type-specific drawing logic.
+   * @param preview - Override settings used in place of those saved to the scene data.
+   *                  (default: `{}`)
+   */
+  draw(preview?: BaseGrid.Preview | undefined): this;
 
   /**
    * Highlight a grid position for a certain coordinates
@@ -94,7 +99,7 @@ declare class BaseGrid extends PIXI.Container {
    *                   (default: `{}`)
    * @returns An Array of distance measurements for each segment
    */
-  measureDistances(segments: GridLayer.Segment[], options?: BaseGrid.MeasureDistancesOptions): number[];
+  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions | undefined): number[];
 
   /**
    * Get the grid row and column positions which are neighbors of a certain position
@@ -114,6 +119,20 @@ declare namespace BaseGrid {
     even?: boolean;
   }
 
+  interface Preview {
+    /**
+     * The grid color.
+     * @defaultValue `null`
+     */
+    gridColor?: string | null | undefined;
+
+    /**
+     * The grid transparency.
+     * @defaultValue `null`
+     */
+    gridAlpha?: number | null | undefined;
+  }
+
   interface HighlightGridPositionOptions {
     /**
      * The x-coordinate of the highlighted position
@@ -149,8 +168,4 @@ declare namespace BaseGrid {
      */
     shape?: PIXI.Polygon | null;
   }
-
-  interface MeasureDistancesOptions {
-    gridSpaces?: boolean;
-  }
 }

package/src/foundry/foundry.js/pixi/containers/baseGrids/hexagonalGrid.d.ts

@@ -28,7 +28,7 @@ declare class HexagonalGrid extends BaseGrid {
   get hexPoints(): PointArray[];
 
   /** @override */
-  draw(): this;
+  draw(preview?: BaseGrid.Preview | undefined): this;
 
   /**
    * A convenience method for getting all the polygon points relative to a top-left [x,y] coordinate pair
@@ -39,10 +39,17 @@ declare class HexagonalGrid extends BaseGrid {
    */
   getPolygon(x: number, y: number, w?: number, h?: number): PointArray[];
 
-  protected _drawGrid(): PIXI.Graphics;
+  /**
+   * Draw the grid lines.
+   * @param preview - Override settings used in place of those saved to the scene data.
+   * @internal
+   */
+  protected _drawGrid(preview?: BaseGrid.Preview | undefined): PIXI.Graphics;
 
+  /** @internal */
   protected _drawRows(grid: PIXI.Graphics, nrows: number, ncols: number): void;
 
+  /** @internal */
   protected _drawColumns(grid: PIXI.Graphics, nrows: number, ncols: number): void;
 
   /**
@@ -67,7 +74,8 @@ declare class HexagonalGrid extends BaseGrid {
    */
   getSnappedPosition(x: number, y: number, interval?: number | null): { x: number; y: number };
 
-  _getClosestVertex(xc: number, yc: number, ox: number, oy: number): { x: number; y: number };
+  /** @internal */
+  protected _getClosestVertex(xc: number, yc: number, ox: number, oy: number): { x: number; y: number };
 
   /** @override */
   shiftPosition(x: number, y: number, dx: number, dy: number): PointArray;
@@ -81,11 +89,8 @@ declare class HexagonalGrid extends BaseGrid {
   /** @override */
   getNeighbors(row: number, col: number): PointArray[];
 
-  /**
-   * @override
-   * @param options - (default: `{}`)
-   */
-  measureDistances(segments: GridLayer.Segment[], options?: BaseGrid.MeasureDistancesOptions): number[];
+  /** @override */
+  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
 
   /**
    * Convert an offset coordinate (row, col) into a cube coordinate (q, r, s).