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

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

@@ -4,7 +4,7 @@ import { Document } from '../../../common/abstract/module.mjs';
 
 declare global {
   /**
-   * An Abstract Base Class which defines a Placeable Object which represents an Entity placed on the Canvas
+   * An Abstract Base Class which defines a Placeable Object which represents a Document placed on the Canvas
    */
   abstract class PlaceableObject<
     D extends Document<any, InstanceType<ConfiguredDocumentClass<typeof Scene>>> = Document<
@@ -68,8 +68,8 @@ declare global {
     protected _hover: boolean;
 
     /**
-     * Identify the official EmbeddedEntity name for this PlaceableObject class
-     * @remarks This getter is abstract in {@link PlaceableObject}.
+     * Identify the official Document name for this PlaceableObject class
+     * @remarks This is abstract in {@link PlaceableObject}.
      */
     static embeddedName: string;
 
@@ -77,7 +77,7 @@ declare global {
      * The bounding box for this PlaceableObject.
      * This is required if the layer uses a Quadtree, otherwise it is optional
      */
-    get bounds(): Rectangle;
+    abstract get bounds(): Rectangle;
 
     /**
      * The central coordinate pair of the placeable object based on it's own width and height
@@ -106,8 +106,8 @@ declare global {
     get los(): this['vision']['los'];
 
     /**
-     * A Form Application which is used to configure the properties of this Placeable Object or the EmbeddedEntity
-     * it represents.
+     * A Form Application which is used to configure the properties of this Placeable Object or the Document it
+     * represents.
      */
     get sheet(): 'sheet' extends keyof D ? D['sheet'] : FormApplication | null;
 
@@ -151,7 +151,7 @@ declare global {
     protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to create the underlying Embedded Entity?
+     * Does the User have permission to create the underlying Document?
      * @param event - (unused)
      */
     protected _canCreate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -169,13 +169,13 @@ declare global {
     protected _canHover(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to update the underlying Embedded Entity?
+     * Does the User have permission to update the underlying Document?
      * @param event - (unused)
      */
     protected _canUpdate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to delete the underlying Embedded Entity?
+     * Does the User have permission to delete the underlying Document?
      * @param event - (unused)
      */
     protected _canDelete(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -378,52 +378,6 @@ declare global {
      * @param event - The triggering mouse click event
      */
     protected _onDragLeftCancel(event: MouseEvent): void;
-
-    /**
-     * @deprecated since 0.8.0
-     * @param options - (default: `{}`)
-     */
-    static create(
-      data:
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1][],
-      options?: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    update(data: Parameters<D['update']>[0], options: Parameters<D['update']>[1]): ReturnType<D['update']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    delete(options: Parameters<D['delete']>[0]): ReturnType<D['delete']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    getFlag(scope: string, key: string): ReturnType<D['getFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    setFlag(scope: string, key: string, value: unknown): ReturnType<D['setFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    unsetFlag(scope: string, key: string): ReturnType<D['unsetFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get uuid(): string;
-
-    /**
-     * @deprecated since 0.8.2
-     */
-    static get layer(): PlaceablesLayer<any>;
   }
 
   namespace PlaceableObject {

package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientSound.d.ts

@@ -27,6 +27,9 @@ declare global {
      */
     get isAudible(): boolean;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A convenience accessor for the sound type
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/drawing.d.ts

@@ -59,6 +59,9 @@ declare global {
      */
     static FREEHAND_SAMPLE_RATE: number;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A Boolean flag for whether or not the Drawing utilizes a tiled texture background
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/measuredTemplate.d.ts

@@ -33,6 +33,9 @@ declare global {
     /** @override */
     static embeddedName: 'MeasuredTemplate';
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A convenience accessor for the border color as a numeric hex code
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/note.d.ts

@@ -10,6 +10,9 @@ declare global {
     /** @override */
     static get embeddedName(): 'Note';
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * The associated JournalEntry which is described by this note
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/tile.d.ts

@@ -72,6 +72,9 @@ declare global {
      */
     get aspectRatio(): number;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * The HTML source element for the primary Tile texture
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/token.d.ts

@@ -77,6 +77,9 @@ declare global {
      */
     readonly name: string;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * Translate the token's grid width into a pixel width based on the canvas size
      */

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygon.d.ts

@@ -42,8 +42,9 @@ declare abstract class PointSourcePolygon extends PIXI.Polygon {
   /**
    * A cached array of SightRay objects used to compute the polygon.
    * @defaultValue `[]`
+   * @remarks This is documented as `SightRay[]` but that's only correct for the {@link RadialSweepPolygon}
    */
-  rays: SightRay[];
+  rays: Ray[];
 
   /**
    * Compute the rectangular bounds for the Polygon.
@@ -66,11 +67,12 @@ declare abstract class PointSourcePolygon extends PIXI.Polygon {
    * Compute the polygon given a point origin and radius
    * @param origin - The origin source point
    * @param config - Configuration options which customize the polygon computation
+   *                 (default: `{}`)
    * @returns The computed polygon instance
    */
   static create(
     origin: Point,
-    config: Parameters<PointSourcePolygon['initialize']>[1]
+    config?: Parameters<PointSourcePolygon['initialize']>[1] | undefined
   ): ReturnType<PointSourcePolygon['compute']>;
 
   /**

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts

@@ -37,13 +37,13 @@ declare global {
      * The minimum ray of emission
      * @defaultValue `Ray.fromAngle(origin.x, origin.y, config.aMin, config.radius)`
      */
-    rMin?: Ray;
+    rMin?: PolygonRay;
 
     /**
      * The maximum ray of emission
      * @defaultValue `config.hasLimitedAngle && Ray.fromAngle(origin.x, origin.y, config.aMax, config.radius)`
      */
-    rMax?: Ray;
+    rMax?: PolygonRay;
 
     /**
      * Does this polygon have a limited radius?
@@ -70,6 +70,10 @@ declare global {
     radiusE?: number;
   }
 
+  interface PolygonRay extends Ray {
+    result: CollisionResult;
+  }
+
   /**
    * A PointSourcePolygon implementation that uses CCW (counter-clockwise) geometry orientation.
    * Sweep around the origin, accumulating collision points based on the set of active walls.
@@ -97,7 +101,7 @@ declare global {
     /**
      * A collection of rays which are fired at vertices
      */
-    rays: SightRay[];
+    rays: PolygonRay[];
 
     static benchmark(
       iterations: number,
@@ -125,7 +129,7 @@ declare global {
      * @returns The ray with rounded vertices
      * @internal
      */
-    protected _roundRayVertices(ray: Ray): Ray;
+    protected _roundRayVertices(ray: PolygonRay): PolygonRay;
 
     /**
      * Translate walls and other obstacles into edges which limit visibility
@@ -194,7 +198,7 @@ declare global {
      * @internal
      */
     protected _isVertexBehindActiveEdges(
-      ray: Ray,
+      ray: PolygonRay,
       vertex: PolygonVertex,
       activeEdges: EdgeSet
     ): { isBehind: boolean; wasLimited: boolean };
@@ -207,7 +211,12 @@ declare global {
      * @param activeEdges - The set of active edges
      * @internal
      */
-    protected _determineRayResult(ray: Ray, vertex: PolygonVertex, result: CollisionResult, activeEdges: EdgeSet): void;
+    protected _determineRayResult(
+      ray: PolygonRay,
+      vertex: PolygonVertex,
+      result: CollisionResult,
+      activeEdges: EdgeSet
+    ): void;
 
     /**
      * Jump to a new closest active edge.
@@ -223,7 +232,7 @@ declare global {
      *                          (default: `true`)
      */
     protected _beginNewEdge(
-      ray: Ray,
+      ray: PolygonRay,
       result: CollisionResult,
       activeEdges: EdgeSet,
       isBinding: boolean,
@@ -241,7 +250,12 @@ declare global {
      * @param activeEdges - The set of currently active edges
      * @param isBinding   - Is the target vertex a binding collision point?
      */
-    protected _completeCurrentEdge(ray: Ray, result: CollisionResult, activeEdges: EdgeSet, isBinding: boolean): void;
+    protected _completeCurrentEdge(
+      ray: PolygonRay,
+      result: CollisionResult,
+      activeEdges: EdgeSet,
+      isBinding: boolean
+    ): void;
 
     /**
      * Augment a CollisionResult with an additional secondary collision.
@@ -251,7 +265,7 @@ declare global {
      * @param edges  - The subset of active edges which are candidates for collision
      * @internal
      */
-    protected _getSecondaryCollisions(ray: Ray, result: CollisionResult, edges: EdgeSet): PolygonVertex[];
+    protected _getSecondaryCollisions(ray: PolygonRay, result: CollisionResult, edges: EdgeSet): PolygonVertex[];
 
     /**
      * Identify collision points for a required terminal ray.
@@ -261,7 +275,7 @@ declare global {
      * @param result      - The pending collision result
      * @param activeEdges - The set of currently active edges
      */
-    protected _findRequiredCollision(ray: Ray, result: CollisionResult, activeEdges: EdgeSet): void;
+    protected _findRequiredCollision(ray: PolygonRay, result: CollisionResult, activeEdges: EdgeSet): void;
 
     /**
      * Identify the collision points between an emitted Ray and a set of active edges.
@@ -271,7 +285,7 @@ declare global {
      * @internal
      */
     protected _getRayCollisions(
-      ray: Ray,
+      ray: PolygonRay,
       activeEdges: EdgeSet,
       {
         minimumDistance
@@ -304,7 +318,7 @@ declare global {
      * @param r1 - The next ray that collides with some vertex
      * @internal
      */
-    protected _getPaddingPoints(r0: Ray, r1: Ray): Point[];
+    protected _getPaddingPoints(r0: PolygonRay, r1: PolygonRay): Point[];
 
     /**
      * Test whether a wall should be included in the computed polygon for a given origin and type
@@ -328,7 +342,7 @@ declare global {
      * @param angle  - The angle being tested, in degrees
      * @returns Is the vertex between the two rays?
      */
-    static pointBetweenRays(vertex: PolygonVertex, rMin: Ray, rMax: Ray, angle: number): boolean;
+    static pointBetweenRays(vertex: PolygonVertex, rMin: PolygonRay, rMax: PolygonRay, angle: number): boolean;
 
     /** @override */
     visualize(): void;
@@ -342,7 +356,7 @@ declare global {
      *          The closest collision, if mode is "closest"
      */
     static getRayCollisions<Mode extends 'any' | 'closest' | 'all'>(
-      ray: Ray,
+      ray: PolygonRay,
       options?: {
         /**
          * Which collision type to check, a value in CONST.WALL_RESTRICTION_TYPES
@@ -368,7 +382,7 @@ declare global {
      * Visualize the polygon, displaying its computed area, rays, and collision points
      * @internal
      */
-    protected static _visualizeCollision(ray: Ray, edges: EdgeSet, collisions: PolygonVertex[]): void;
+    protected static _visualizeCollision(ray: PolygonRay, edges: EdgeSet, collisions: PolygonVertex[]): void;
   }
 
   namespace ClockwiseSweepPolygon {
@@ -385,12 +399,12 @@ declare global {
       rotation: number;
       hasLimitedAngle: boolean;
       density: number;
-      rMin: Ray;
+      rMin: PolygonRay;
     }
 
     interface LimitedAngleConfig extends InitializedConfig {
       hasLimitedAngle: true;
-      rMax: Ray;
+      rMax: PolygonRay;
     }
   }
 }

package/src/foundry/foundry.js/rollTerms/diceTerms/die.d.ts

@@ -207,11 +207,6 @@ declare class Die extends DiceTerm {
 }
 
 declare namespace Die {
-  interface Data extends Partial<TermData> {
-    class: 'Die';
-    results: DiceTerm.Result[];
-  }
-
   interface TermData extends DiceTerm.TermData {
     modifiers: Array<keyof typeof Die['MODIFIERS']>;
   }

package/src/foundry/foundry.js/rollTerms/diceTerms/fateDie.d.ts

@@ -3,7 +3,7 @@
  * Mathematically behaves like 1d3-2
  */
 declare class FateDie extends DiceTerm {
-  constructor(termData?: Partial<DiceTerm.TermData>);
+  constructor(termData?: Partial<FateDie.TermData>);
 
   faces: 3;
 
@@ -12,6 +12,9 @@ declare class FateDie extends DiceTerm {
    */
   static DENOMINATION: string;
 
+  /** @override */
+  static MODIFIERS: FateDie.Modifiers;
+
   /**
    * @override
    */
@@ -22,3 +25,20 @@ declare class FateDie extends DiceTerm {
    */
   getResultLabel(result: DiceTerm.Result): string;
 }
+
+declare namespace FateDie {
+  interface TermData extends DiceTerm.TermData {
+    modifiers: Array<keyof typeof FateDie['MODIFIERS']>;
+  }
+
+  interface Modifiers {
+    r: Die['reroll'];
+    rr: Die['rerollRecursive'];
+    k: Die['keep'];
+    kh: Die['keep'];
+    kl: Die['keep'];
+    d: Die['drop'];
+    dh: Die['drop'];
+    dl: Die['drop'];
+  }
+}

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

@@ -5,13 +5,6 @@
 declare class VideoHelper {
   constructor();
 
-  /**
-   * A collection of HTML5 video objects which are currently active within the FVTT page
-   * @defaultValue `[]`
-   * @remarks This seems to be unused.
-   */
-  videos: HTMLVideoElement[];
-
   /**
    * A user gesture must be registered before video playback can begin.
    * This Set records the video elements which await such a gesture.

package/src/foundry/index.d.ts

@@ -20,12 +20,9 @@ import './foundry.js/clientSettings';
 import './foundry.js/collections';
 import './foundry.js/collisionResult';
 import './foundry.js/config';
-import './foundry.js/constants';
 import './foundry.js/contextMenu';
 import './foundry.js/dragDrop';
 import './foundry.js/draggable';
-import './foundry.js/features';
-import './foundry.js/fonts';
 import './foundry.js/formDataExtended';
 import './foundry.js/game';
 import './foundry.js/gameTime';
@@ -74,7 +71,6 @@ import './foundry.js/templateUtils';
 import './foundry.js/textEditor';
 import './foundry.js/textureLoader';
 import './foundry.js/textureUtils';
-import './foundry.js/types';
 import './foundry.js/userTargets';
 import './foundry.js/utils';
 import './foundry.js/videoHelper';

package/src/types/helperTypes.d.ts

@@ -103,6 +103,12 @@ export type PlaceableDocumentType =
   | 'Token'
   | 'Wall';
 
+export type DocumentSubTypes<T extends DocumentType> = 'type' extends keyof InstanceType<
+  ConfiguredDocumentClassForName<T>
+>['data']
+  ? InstanceType<ConfiguredDocumentClassForName<T>>['data']['type']
+  : typeof foundry.CONST.BASE_DOCUMENT_TYPE;
+
 export type ConfiguredDocumentClassForName<Name extends DocumentType> = CONFIG[Name]['documentClass'];
 
 export type ConfiguredObjectClassForName<Name extends PlaceableDocumentType> = CONFIG[Name]['objectClass'];