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

package/src/foundry/foundry.js/clientDocuments/rollTable.d.ts

@@ -20,6 +20,11 @@ declare global {
       context?: ConstructorParameters<typeof foundry.documents.BaseRollTable>[1]
     );
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['img'];
+
     /**
      * Display a result drawn from a RollTable in the Chat Log along.
      * Optionally also display the Roll which produced the result and configure aspects of the displayed messages.
@@ -65,6 +70,9 @@ declare global {
      * Note that this function only performs the roll and identifies the result, the RollTable#draw function should be
      * called to formalize the draw from the table.
      *
+     * @param options - (default: `{}`)
+     * @returns The Roll and results drawn by that Roll
+     *
      * @example
      * ```typescript
      * // Draw results using the default table formula
@@ -75,7 +83,7 @@ declare global {
      * const customResults = await table.roll({roll});
      * ```
      */
-    roll(options?: RollTable.RollOptions): Promise<RollTableDraw>;
+    roll(options?: RollTable.RollOptions | undefined): Promise<RollTableDraw>;
 
     /**
      * Get an Array of valid results for a given rolled total
@@ -103,28 +111,22 @@ declare global {
     ): void;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.RollTableData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.RollTableData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.RollTableData extends { toObject(): infer U } ? U : never;
     };
 
     /**
-     * Create a new RollTable entity using all of the Entities from a specific Folder as new results.
-     * @param folder  - The Folder entity from which to create a roll table
+     * Create a new RollTable document using all of the Documents from a specific Folder as new results.
+     * @param folder  - The Folder document from which to create a roll table
      * @param options - Additional options passed to the RollTable.create method
      */
     static fromFolder(
       folder: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseFolder>>,
       options?: DocumentModificationOptions
     ): Promise<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseRollTable>> | undefined>;
-
-    /**
-     * The RollTable#getTableResult method is deprecated in favor of RollTable#results#get and will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    getTableResult(id: string): ReturnType<this['results']['get']>;
   }
 
   namespace RollTable {
@@ -190,7 +192,7 @@ declare global {
       roll?: Roll;
 
       /**
-       * If a RollTable entity is drawn as a result, recursively roll it
+       * If a RollTable document is drawn as a result, recursively roll it
        * @defaultValue `true`
        */
       recursive?: boolean;

package/src/foundry/foundry.js/clientDocuments/scene.d.ts

@@ -68,18 +68,23 @@ declare global {
      */
     get img(): this['data']['img'];
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['thumb'];
+
     /**
      * A convenience accessor for whether the Scene is currently viewed
      */
     get isView(): boolean;
 
     /**
-     * A reference to the JournalEntry entity associated with this Scene, or null
+     * A reference to the JournalEntry document associated with this Scene, or null
      */
     get journal(): InstanceType<ConfiguredDocumentClass<typeof JournalEntry>> | null;
 
     /**
-     * A reference to the Playlist entity for this Scene, or null
+     * A reference to the Playlist document for this Scene, or null
      */
     get playlist(): InstanceType<ConfiguredDocumentClass<typeof Playlist>> | null;
 
@@ -435,10 +440,10 @@ declare global {
     ): void;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.SceneData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.SceneData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.SceneData extends { toObject(): infer U } ? U : never;
     };
 
@@ -451,7 +456,7 @@ declare global {
   }
 }
 
-interface ThumbnailCreationData {
+interface ThumbnailCreationData extends ImageHelper.TextureToImageOptions {
   /**
    * A background image to use for thumbnail creation, otherwise the current scene
    * background is used.

package/src/foundry/foundry.js/clientDocuments/user.d.ts

@@ -90,7 +90,7 @@ declare global {
 
     /**
      * Assign a Macro to a numbered hotbar slot between 1 and 50
-     * @param macro    - The Macro entity to assign
+     * @param macro    - The Macro document to assign
      * @param slot     - A specific numbered hotbar slot to fill
      * @param fromSlot - An optional origin slot from which the Macro is being shifted
      * @returns A Promise which resolves once the User update is complete
@@ -120,7 +120,7 @@ declare global {
     broadcastActivity(activityData?: ActivityData): void;
 
     /**
-     * Get an Array of Macro Entities on this User's Hotbar by page
+     * Get an Array of Macro Documents on this User's Hotbar by page
      * @param page - The hotbar page number
      *               (default: `1`)
      */
@@ -145,16 +145,6 @@ declare global {
     /** @override  */
     _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /**
-     * @deprecated since 0.8.0
-     */
-    isRole(role: Parameters<User['hasRole']>[0]): boolean;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    setPermission(permission: keyof typeof CONST.USER_PERMISSIONS, allowed: boolean): Promise<this>;
-
     /** @remarks This property is set by PlayerList.getData() */
     charname?: string;
 

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

@@ -20,12 +20,12 @@ declare global {
     /**
      * A object of registered game settings for this scope
      */
-    settings: Map<string, ClientSettings.CompleteSetting>;
+    settings: Map<string, SettingConfig>;
 
     /**
      * Registered settings menus which trigger secondary applications
      */
-    menus: Map<string, ClientSettings.CompleteMenuSetting>;
+    menus: Map<string, SettingSubmenuConfig>;
 
     /**
      * The storage interfaces used for persisting settings
@@ -47,12 +47,12 @@ declare global {
     /**
      * 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
+     * @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
@@ -95,22 +95,22 @@ declare global {
      * });
      * ```
      */
-    register<M extends string, K extends string, T>(
-      module: M,
+    register<N extends string, K extends string, T>(
+      namespace: N,
       key: K,
-      data: ClientSettings.Values[`${M}.${K}`] extends boolean | number | bigint | string | symbol | object
-        ? ClientSettings.PartialSetting<ClientSettings.Values[`${M}.${K}`]>
-        : ClientSettings.PartialSetting<T>
+      data: ClientSettings.Values[`${N}.${K}`] extends string | number | boolean | Array<any> | object
+        ? ClientSettings.PartialSettingConfig<ClientSettings.Values[`${N}.${K}`]>
+        : ClientSettings.PartialSettingConfig<T>
     ): void;
 
     /**
      * 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
+     * @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
@@ -125,19 +125,19 @@ declare global {
      * });
      * ```
      */
-    registerMenu<M extends string, K extends string>(
-      module: M,
+    registerMenu<N extends string, K extends string>(
+      namespace: N,
       key: K,
-      data: ClientSettings.RegisteredMenuSettings[`${M}.${K}`]
+      data: ClientSettings.PartialSettingSubmenuConfig
     ): void;
 
     /**
-     * Get the value of a game setting for a certain module and setting key
+     * Get the value of a game setting for a certain namespace 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
+     * @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
@@ -145,17 +145,17 @@ declare global {
      * game.settings.get("myModule", "myClientSetting");
      * ```
      */
-    get<M extends string, K extends string>(module: M, key: K): ClientSettings.Values[`${M}.${K}`];
+    get<N extends string, K extends string>(namespace: N, key: K): ClientSettings.Values[`${N}.${K}`];
 
     /**
-     * Set the value of a game setting for a certain module and setting key
+     * Set the value of a game setting for a certain namespace 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
+     * @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
@@ -163,65 +163,17 @@ declare global {
      * game.settings.set("myModule", "myClientSetting", "b");
      * ```
      */
-    set<M extends string, K extends string, V extends ClientSettings.Values[`${M}.${K}`]>(
-      module: M,
+    set<N extends string, K extends string, V extends ClientSettings.Values[`${N}.${K}`]>(
+      namespace: N,
       key: K,
       value: V
     ): Promise<V>;
   }
 
   namespace ClientSettings {
-    interface CompleteSetting<T = unknown> extends PartialSetting<T> {
-      key: string;
-      module: string;
-    }
-
-    interface CompleteMenuSetting extends PartialMenuSetting {
-      key: string;
-      module: string;
-    }
-
-    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>;
-    }
-
-    interface PartialMenuSetting {
-      hint?: string;
-      icon?: string;
-      label?: string;
-      name?: string;
-      restricted: boolean;
-      type: ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
-    }
+    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;

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).

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

@@ -3,9 +3,10 @@
  */
 declare class SquareGrid extends BaseGrid {
   /** @override */
-  draw(): this;
+  draw(preview?: BaseGrid.Preview | undefined): this;
 
-  _drawLine(
+  /** @internal */
+  protected _drawLine(
     points: [x1: number, y1: number, x2: number, y2: number],
     lineColor: number,
     lineAlpha: number
@@ -35,6 +36,7 @@ declare class SquareGrid extends BaseGrid {
    */
   shiftPosition(x: number, y: number, dx: number, dy: number): PointArray;
 
+  /** @internal */
   protected _getNearestVertex(x: number, y: number): PointArray;
 
   /**
@@ -47,7 +49,7 @@ declare class SquareGrid extends BaseGrid {
    * @override
    * @param options - (default: `{}`)
    */
-  measureDistances(segments: GridLayer.Segment[], options?: BaseGrid.MeasureDistancesOptions): number[];
+  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
 
   /** @override */
   getNeighbors(row: number, col: number): PointArray[];

package/src/foundry/foundry.js/pixi/containers/canvasLayers/gridLayer.d.ts

@@ -92,9 +92,11 @@ declare class GridLayer extends CanvasLayer<GridLayer.LayerOptions> {
   getCenter(x: number, y: number): PointArray;
 
   /**
-   * Measure the grid-wise distance between two point coordinates.
-   * @param origin - The origin point
-   * @param target - The target point
+   * Measure the distance between two point coordinates.
+   * @param origin  - The origin point
+   * @param target  - The target point
+   * @param options - Additional options which modify the measurement
+   *                  (default: `{}`)
    * @returns The measured distance between these points
    *
    * @example
@@ -110,15 +112,17 @@ declare class GridLayer extends CanvasLayer<GridLayer.LayerOptions> {
     target: {
       x: number;
       y: number;
-    }
+    },
+    options?: MeasureDistancesOptions | undefined
   ): number;
 
   /**
    * Measure the distance traveled over an array of distance segments.
    * @param segments - An array of measured segments
    * @param options  - Additional options which modify the measurement
+   *                   (default: `{}`)
    */
-  measureDistances(segments: GridLayer.Segment[], options?: { gridSpaces?: boolean }): number[];
+  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions | undefined): number[];
 
   /**
    * Define a new Highlight graphic
@@ -194,3 +198,8 @@ interface DrawOptions {
    */
   gridAlpha?: number | null;
 }
+
+interface MeasureDistancesOptions {
+  /** Return the distance in grid increments rather than the co-ordinate distance. */
+  gridSpaces?: boolean;
+}