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

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/collections/documentCollections/compendiumCollection.d.ts

@@ -169,7 +169,7 @@ declare global {
      *          null if the dialog was closed without making a choice.
      */
     importDialog(
-      options?: Dialog.Options | undefined
+      options?: DialogOptions | undefined
     ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[] | null | false>;
 
     /**

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/handlebarsHelpers.d.ts

@@ -7,6 +7,23 @@ declare class HandlebarsHelpers {
    */
   static checked(value: unknown): string;
 
+  /**
+   * For use in form inputs. If the supplied value is truthy, add the "disabled" property, otherwise add nothing.
+   */
+  static disabled(value: unknown): string;
+
+  /**
+   * Concatenate a number of string terms into a single string.
+   * This is useful for passing arguments with variable names.
+   * @param values - The values to concatenate
+   *
+   * @example <caption>Concatenate several string parts to create a dynamic variable</caption>
+   * ```handlebars
+   * {{filePicker target=(concat "faces." i ".img") type="image"}}
+   * ```
+   */
+  static concat(...values: string[]): Handlebars.SafeString;
+
   /**
    * Render a pair of inputs for selecting a color.
    * @param options - Helper options
@@ -31,12 +48,15 @@ declare class HandlebarsHelpers {
    * @example <caption>Translate a provided localization string, optionally including formatting parameters</caption>
    * ```handlebars
    * <label>{{localize "ACTOR.Create"}}</label> <!-- "Create Actor" -->
-   * <label>{{localize "CHAT.InvalidCommand", command=foo}}</label> <!-- "foo is not a valid chat message command." -->
+   * <label>{{localize "CHAT.InvalidCommand" command=foo}}</label> <!-- "foo is not a valid chat message command." -->
    * ```
    */
   static localize(value: string, options: HandlebarsHelpers.LocalizeOptions): string;
 
   /**
+   * @param value   - A numeric value to format
+   * @param options - Additional options which customize the resulting format
+   * @returns The formatted string to be included in a template
    * A string formatting helper to display a number with a certain fixed number of decimals and an explicit sign.
    */
   static numberFormat(value: string, options: HandlebarsHelpers.NumberFormatOptions): string;
@@ -78,7 +98,7 @@ declare class HandlebarsHelpers {
   ): Handlebars.SafeString;
 
   /**
-   * Render a pair of inputs for selecting a color.
+   * Render a pair of inputs for selecting a value in a range.
    * @param options - Helper options
    */
   static rangePicker(options: HandlebarsHelpers.RangePickerOptions): Handlebars.SafeString;
@@ -206,10 +226,10 @@ declare namespace HandlebarsHelpers {
       editable?: boolean;
 
       /**
-       * Replace dynamic entity links?
+       * Replace dynamic document links?
        * @defaultValue `true`
        */
-      entities?: boolean;
+      documents?: boolean;
 
       /**
        * The data object providing context for inline rolls
@@ -245,11 +265,13 @@ declare namespace HandlebarsHelpers {
   interface NumberFormatOptions extends Handlebars.HelperOptions {
     hash: {
       /**
+       * The number of decimal places to include in the resulting string
        * @defaultValue `0`
        */
       decimals?: number;
 
       /**
+       * Whether to include an explicit "+" sign for positive numbers
        * @defaultValue `false`
        */
       sign?: boolean;

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

@@ -96,7 +96,7 @@ declare class MouseInteractionManager<Object extends PIXI.Container = PIXI.Conta
 
   /**
    * The throttling time below which a mouse move event will not be handled
-   * @defaultValue `Math.ceil(1000 / canvas.app.ticker.maxFPS)`
+   * @defaultValue `Math.ceil(1000 / (canvas.app.ticker.maxFPS || 60));`
    * @internal
    */
   protected _dragThrottleMS: number;

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

@@ -92,7 +92,7 @@ declare namespace PerceptionManager {
     sight: {
       initialize: boolean;
       refresh: boolean;
-      noUpdateFog: boolean;
+      skipUpdateFog: boolean;
       forceUpdateFog: boolean;
     };
     sounds: {

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;
+}

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

@@ -9,6 +9,7 @@ import './cursor';
 import './doorControl';
 import './effectsCanvasGroup';
 import './interfaceCanvasGroup';
+import './objectHUD';
 import './placeableObject';
 import './placeableObjects';
 import './ruler';

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

@@ -0,0 +1,82 @@
+/**
+ * An extension of PIXI.Container used as the interface frame for a PlaceableObject on the ControlsLayer
+ *
+ * @see {@link PlaceableObject}
+ * @see {@link ControlsLayer}
+ */
+declare class ObjectHUD extends PIXI.Container {
+  constructor(object: PIXI.DisplayObject);
+
+  /**
+   * The object that this HUD container is linked to
+   */
+  object: PIXI.DisplayObject;
+
+  /**
+   * Use the linked object's transform matrix to easily synchronize position
+   */
+  transform: PIXI.Transform;
+
+  /** @override */
+  // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
+  get visible(): boolean;
+  set visible(value: boolean);
+
+  /** @override */
+  // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
+  get renderable(): boolean;
+  set renderable(value: boolean);
+
+  /**
+   * Display scrolling status text originating from this ObjectHUD container.
+   * @param content - The text content to display
+   * @param options - (default: `{}`)
+   * @returns The created PreciseText object which is scrolling
+   */
+  createScrollingText(
+    content: string,
+    options?: ObjectHUD.CreateScrollingTextOptions | undefined
+  ): Promise<PreciseText | null>;
+
+  /**
+   * Orchestrate the animation of the scrolling text in this HUD
+   * @param text     - The PrecisText instance to animate
+   * @param duration - A desired duration of animation
+   * @param dx       - A horizontal distance to animate the text
+   *                   (default: `0`)
+   * @param dy       - A vertical distance to animate the text
+   *                   (default: `0`)
+   * @internal
+   */
+  protected _animateScrollText(text: PreciseText, duration: number, dx?: number, dy?: number): Promise<void>;
+}
+
+type TextStyleProperties = Exclude<ConstructorParameters<typeof PIXI.TextStyle>[0], undefined>;
+
+declare namespace ObjectHUD {
+  interface CreateScrollingTextOptions extends TextStyleProperties {
+    /**
+     * The original anchor point where the text first appears
+     * @defaultValue `CONST.TEXT_ANCHOR_POINTS.CENTER`
+     */
+    anchor?: foundry.CONST.TEXT_ANCHOR_POINTS | undefined;
+
+    /**
+     * The direction in which the text scrolls
+     * @defaultValue `CONST.TEXT_ANCHOR_POINTS.TOP`
+     */
+    direction?: foundry.CONST.TEXT_ANCHOR_POINTS | undefined;
+
+    /**
+     * The duration of the scrolling effect in milliseconds
+     * @defaultValue `2000`
+     */
+    duration?: number | undefined;
+
+    /**
+     * An amount of randomization between 0 and 1 to apply to the initial Position
+     * @defaultValue `0`
+     */
+    jitter?: number | undefined;
+  }
+}