@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/client/index.d.ts

@@ -0,0 +1,12 @@
+import './apps';
+import './audio';
+import './av';
+import './config';
+import './core';
+import './data';
+import './dice';
+import './game';
+import './head';
+import './pixi';
+import './tail';
+import './ui';

package/src/foundry/{foundry.js/canvas.d.ts → client/pixi/board.d.ts}

@@ -1,27 +1,26 @@
-import { ConfiguredDocumentClass } from '../../types/helperTypes';
-import { BaseScene } from '../common/documents.mjs';
-
-/**
- * The virtual tabletop environment is implemented using a WebGL powered HTML 5 canvas using the powerful PIXI.js
- * library. The canvas is comprised of an ordered sequence of layers which define rendering groups and collections of
- * objects that are drawn on the canvas itself.
- *
- * @see {@link CanvasLayer} An abstract class for all Canvas layers.
- * @see {@link PlaceablesLayer} An abstract class for Canvas Layers which contain Placeable Objects.
- * @see {@link PlaceableObject} An abstract class for objects which are placed into the Scene and drawn on the canvas.
- *
- * @example <caption>Example Canvas commands</caption>
- * ```typescript
- * canvas.ready; // Is the canvas ready for use?
- * canvas.scene; // The currently viewed Scene document.
- * canvas.dimensions; // The dimensions of the current Scene.
- * canvas.draw(); // Completely re-draw the game canvas (this is usually unnecessary).
- * canvas.pan(x, y, zoom); // Pan the canvas to new coordinates and scale.
- * canvas.recenter(); // Re-center the canvas on the currently controlled Token.
- * ```
- */
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { BaseScene } from '../../common/documents.mjs';
 
 declare global {
+  /**
+   * The virtual tabletop environment is implemented using a WebGL powered HTML 5 canvas using the powerful PIXI.js
+   * library. The canvas is comprised of an ordered sequence of layers which define rendering groups and collections of
+   * objects that are drawn on the canvas itself.
+   *
+   * @see {@link CanvasLayer} An abstract class for all Canvas layers.
+   * @see {@link PlaceablesLayer} An abstract class for Canvas Layers which contain Placeable Objects.
+   * @see {@link PlaceableObject} An abstract class for objects which are placed into the Scene and drawn on the canvas.
+   *
+   * @example <caption>Example Canvas commands</caption>
+   * ```typescript
+   * canvas.ready; // Is the canvas ready for use?
+   * canvas.scene; // The currently viewed Scene document.
+   * canvas.dimensions; // The dimensions of the current Scene.
+   * canvas.draw(); // Completely re-draw the game canvas (this is usually unnecessary).
+   * canvas.pan(x, y, zoom); // Pan the canvas to new coordinates and scale.
+   * canvas.recenter(); // Re-center the canvas on the currently controlled Token.
+   * ```
+   */
   class Canvas {
     constructor();
 
@@ -433,7 +432,6 @@ declare global {
     /**
      * Handle the conclusion of a right-mouse drag workflow the Canvas stage.
      * @see {@link MouseInteractionManager#_handleDragDrop}
-     * @param event - (unused)
      */
     protected _onDragRightDrop(event: PIXI.InteractionEvent): void;
 
@@ -486,7 +484,6 @@ declare global {
     /**
      * Get a reference to the a specific CanvasLayer by it's name
      * @param layerName - The name of the canvas layer to get
-     *                    (unused)
      * @deprecated since v9, will be deleted in v10
      */
     getLayer(layerName: any): {

package/src/foundry/client/pixi/core/containers/index.d.ts

@@ -0,0 +1,3 @@
+import './cached-container';
+import './quadtree';
+import './sampler-mesh';

package/src/foundry/{foundry.js/screenCulling.d.ts → client/pixi/core/culling.d.ts}

@@ -17,3 +17,21 @@ declare class ScreenCulling {
    */
   intersects(rect: Rectangle, bounds: Rectangle): boolean;
 }
+
+/**
+ * An experimental approach to culling using the quadtree mapping rather than the screen rectangle.
+ * @internal
+ */
+declare class QuadtreeCulling {
+  constructor();
+
+  cull(screen: Rectangle): void;
+
+  protected _getRect(screen: Rectangle): NormalizedRectangle;
+}
+
+/**
+ * Benchmark the performance of different culling methods
+ * @internal
+ */
+declare function benchmarkCulling(n?: number): Promise<void>;

package/src/foundry/client/pixi/core/index.d.ts

@@ -0,0 +1,5 @@
+import './containers';
+import './culling';
+import './interaction';
+import './loader';
+import './shapes';

package/src/foundry/{foundry.js/pixi/containers/controlIcon.d.ts → client/pixi/core/interaction/control-icon.d.ts}

@@ -27,6 +27,9 @@ declare class ControlIcon extends PIXI.Container {
 
   borderColor: number;
 
+  /**
+   * The color of the icon tint, if any
+   */
   tintColor: number | null;
 
   /**

package/src/foundry/client/pixi/core/interaction/index.d.ts

@@ -0,0 +1,5 @@
+import './canvas-animation';
+import './control-icon';
+import './mouse-handler';
+import './resize-handle';
+import './targets';

package/src/foundry/{foundry.js/userTargets.d.ts → client/pixi/core/interaction/targets.d.ts}

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../types/helperTypes';
-import { ObjectClass } from '../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ObjectClass } from '../../../../../types/helperTypes';
 
 interface SetReplacementMembers<T> {
   add(value: T): void;
@@ -32,19 +32,16 @@ declare global {
     get ids(): string[];
 
     /**
-     * @override
      * @remarks Returns void, but Set<T>.add returns boolean
      */
-    add(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
+    override add(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
 
-    /** @override */
-    clear(): void;
+    override clear(): void;
 
     /**
-     * @override
      * @remarks Returns void, but Set<T>.delete returns boolean
      */
-    delete(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
+    override delete(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
 
     /**
      * Dispatch the targetToken hook whenever the user's target set changes

package/src/foundry/{foundry.js/textureLoader.d.ts → client/pixi/core/loader.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -143,4 +143,29 @@ declare global {
       pct: number;
     }
   }
+
+  /**
+   * Test whether a file source exists by performing a HEAD request against it
+   * @param src - The source URL or path to test
+   * @returns Does the file exist at the provided url?
+   */
+  function srcExists(src: string): Promise<boolean>;
+
+  /**
+   * Get a single texture from the cache
+   */
+  function getTexture(src: string): PIXI.Texture | null;
+
+  /**
+   * Load a single texture and return a Promise which resolves once the texture is ready to use
+   * @param src      - The requested texture source
+   * @param options  - Additional options which modify texture loading
+   */
+  function loadTexture(
+    src: string,
+    options?: {
+      /** A fallback texture to use if the requested source is unavailable or invalid */
+      fallback?: string | undefined;
+    }
+  ): Promise<PIXI.Texture | null>;
 }

package/src/foundry/client/pixi/core/shapes/index.d.ts

@@ -0,0 +1,5 @@
+import './normalized-rectangle';
+import './polygon-helpers';
+import './precise-text';
+import './ray';
+import './source-polygon';

package/src/foundry/client/pixi/core/shapes/polygon-helpers.d.ts

@@ -0,0 +1,263 @@
+import type { ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
+
+declare global {
+  /**
+   * An internal data structure for polygon vertices
+   * @internal
+   */
+  class PolygonVertex {
+    constructor(x: number, y: number, { distance, index }?: PolygonVertexOptions);
+
+    x: number;
+
+    y: number;
+
+    key: number;
+
+    protected _distance: number | undefined;
+
+    protected _d2: undefined;
+
+    protected _index: number | undefined;
+
+    /** @defaultValue `false` */
+    protected _inLimitedAngle: boolean;
+
+    /**
+     * The set of edges which connect to this vertex.
+     * This set is initially empty and populated later after vertices are de-duplicated.
+     * @defaultValue `new Set()`
+     */
+    edges: EdgeSet;
+
+    /**
+     * The subset of edges which continue clockwise from this vertex.
+     * @defaultValue `new Set()`
+     */
+    cwEdges: EdgeSet;
+
+    /**
+     * The subset of edges which continue counter-clockwise from this vertex.
+     * @defaultValue `new Set()`
+     */
+    ccwEdges: EdgeSet;
+
+    /**
+     * The maximum restriction type of this vertex
+     * @defaultValue `null`
+     */
+    type: number | null;
+
+    /**
+     * Associate an edge with this vertex.
+     * @param edge        - The edge being attached
+     * @param orientation - The orientation of the edge with respect to the origin
+     */
+    attachEdge(edge: PolygonEdge, orientation: number): void;
+
+    /**
+     * Is this vertex limited in type?
+     */
+    get isLimited(): boolean;
+
+    /**
+     * Is this vertex terminal (at the maximum radius)
+     */
+    get isTerminal(): boolean;
+
+    /**
+     * Does this vertex have a limited edge connected to it?
+     */
+    get hasLimitedEdge(): boolean;
+
+    /**declareme point?
+     */
+    equals(other: PolygonVertex): boolean;
+
+    /**
+     * Construct a PolygonVertex instance from some other Point structure.
+     * @param point   - The point
+     * @param options - Additional options that apply to this vertex
+     * @returns The constructed vertex
+     */
+    static fromPoint(point: Point, options?: PolygonVertexOptions): PolygonVertex;
+  }
+
+  interface PolygonVertexOptions {
+    distance: PolygonVertex['_distance'];
+    index: PolygonVertex['_index'];
+  }
+
+  /**
+   * An internal data structure for polygon edges
+   * @internal
+   */
+  class PolygonEdge {
+    constructor(a: Point, b: Point, type: foundry.CONST.WALL_SENSE_TYPES, wall: Wall);
+
+    /**
+     * Is this edge limited in type?
+     */
+    get isLimited(): boolean;
+
+    /**
+     * Construct a PolygonEdge instance from a Wall placeable object.
+     * @param wall - The Wall from which to construct an edge
+     * @param type - The type of polygon being constructed
+     */
+    static fromWall(
+      wall: ConfiguredObjectClassForName<'Wall'> | WallDocument,
+      type: foundry.CONST.WALL_RESTRICTION_TYPES
+    ): PolygonEdge;
+  }
+
+  /**
+   * An object containing the result of a collision test.
+   * @internal
+   */
+  class CollisionResult {
+    constructor(values?: {
+      target?: PolygonVertex | null;
+      collisions?: PolygonVertex[];
+      cwEdges?: EdgeSet;
+      ccwEdges?: EdgeSet;
+      isBehind?: boolean;
+      isLimited?: boolean;
+      isRequired?: boolean;
+      wasLimited?: boolean;
+    });
+
+    /**
+     * The vertex that was the target of this result
+     * @defaultValue `null`
+     */
+    target: PolygonVertex | null;
+
+    /**
+     * The array of collision points which apply to this result
+     * @defaultValue `[]`
+     */
+    collisions: PolygonVertex[];
+
+    /**
+     * The set of edges connected to the target vertex that continue clockwise
+     * @defaultValue `new Set()`
+     */
+    cwEdges: EdgeSet;
+
+    /**
+     * The set of edges connected to the target vertex that continue counter-clockwise
+     * @defaultValue `new Set()`
+     */
+    ccwEdges: EdgeSet;
+
+    /**
+     * Is the target vertex for this result behind some closer active edge?
+     */
+    isBehind: boolean | undefined;
+
+    /**
+     * Does the target vertex for this result impose a limited collision?
+     */
+    isLimited: boolean | undefined;
+
+    /**
+     * Is this result required due to a limited angle?
+     */
+    isRequired: boolean | undefined;
+
+    /**
+     * Has the set of collisions for this result encountered a limited edge?
+     */
+    wasLimited: boolean | undefined;
+  }
+
+  /**
+   * A special subclass of PIXI.Point which is used for modeling Wall endpoints.
+   * A wall endpoint must have integer coordinates.
+   *
+   * This was used for the RadialSweepPolygon but can now be deleted once that is
+   * @deprecated since v9d2
+   */
+  class WallEndpoint extends PIXI.Point {
+    /**
+     * @param x - The integer x-coordinate
+     * @param y - The integer y-coordinate
+     */
+    constructor(x: number, y: number);
+
+    /**
+     * Express the point as a 32-bit integer with 16 bits allocated to x and 16 bits allocated to y
+     */
+    key: number;
+
+    /**
+     * The angle between this point and the polygon origin
+     * @defaultValue `undefined`
+     */
+    angle: number | undefined;
+
+    /**
+     * Record the set of walls which connect to this Endpoint
+     */
+    walls: Set<ConfiguredObjectClassForName<'Wall'>>;
+
+    /**
+     * Record whether this point is the endpoint of any Wall
+     * @defaultValue `false`
+     */
+    isEndpoint: boolean;
+
+    /**
+     * Record whether this point is a midpoint of any wall?
+     * @defaultValue `false`
+     */
+    isMidpoint: boolean;
+
+    /**
+     * Record whether this point is the termination of the Ray
+     * @defaultValue `false`
+     */
+    isTerminal: boolean;
+
+    /**
+     * Aggregate the maximum of each wall restriction type
+     */
+    types: Record<foundry.CONST.WALL_RESTRICTION_TYPES, number>;
+
+    /**
+     * An intermediate variable used to store the proportional distance of this point from a SightRay origin
+     * @defaultValue `undefined`
+     */
+    protected _r: number | undefined;
+
+    /**
+     * An intermediate variable used to cache the continuation attributes for a certain point
+     * @defaultValue `undefined`
+     */
+    protected _c: { left: boolean; right: boolean } | undefined;
+
+    attachWall(wall: ConfiguredObjectClassForName<'Wall'>): this;
+
+    /**
+     * Does this endpoint equal some other endpoint?
+     * @param other - Some other point with x and y coordinates
+     * @returns Are the points equal?
+     */
+    equals(other: Point): boolean;
+
+    /**
+     * Is this point one that provides only limited perspective?
+     * @param type - The perspective type being tested
+     * @returns Is perspective limited?
+     */
+    isLimited(type: foundry.CONST.WALL_RESTRICTION_TYPES): boolean;
+
+    /**
+     * Encode a x/y coordinate as a 32-bit integer
+     * @param x - The x-coordinate
+     * @param y - The y-coordinate
+     */
+    static getKey(x: number, y: number): number;
+  }
+}

package/src/foundry/{foundry.js → client/pixi/core/shapes}/ray.d.ts

@@ -1,4 +1,4 @@
-import type { LineIntersection } from '../common/utils/geometry.mjs';
+import type { LineIntersection } from '../../../../common/utils/geometry.mjs.js';
 
 declare global {
   interface RayIntersection {
@@ -162,4 +162,39 @@ declare global {
      */
     intersectSegment(coords: [x0: number, y0: number, x1: number, y1: number]): LineIntersection | null;
   }
+
+  /**
+   * A subclass of Ray that is used specifically for computing source polygons
+   *
+   * This was used for the RadialSweepPolygon but can now be deleted once that is
+   * @deprecated since v9d2
+   */
+  class SightRay extends Ray {
+    /**
+     * The array of sorted collision points which apply for this Ray.
+     */
+    collisions: WallEndpoint[];
+
+    /**
+     * The target endpoint at which this Ray was fired
+     */
+    endpoint: WallEndpoint | null;
+
+    /**
+     * The result objects which records the outcome of this Ray
+     */
+    result: {
+      collisions: unknown[];
+      continuation: unknown | undefined;
+      limitation: number;
+      superfluous: boolean;
+      stopped: boolean;
+      activeWalls: unknown | undefined;
+    };
+
+    /**
+     * The final collision point that this SightRay encountered.
+     */
+    get lastCollision(): WallEndpoint | null;
+  }
 }

package/src/foundry/{foundry.js/pixi/polygons/pointSourcePolygon.d.ts → client/pixi/core/shapes/source-polygon.d.ts}

@@ -98,3 +98,13 @@ declare abstract class PointSourcePolygon extends PIXI.Polygon {
    */
   visualize(): void;
 }
+
+/**
+ * Compare sight performance between different algorithms
+ * @param n    - The number of iterations
+ * @param args - Arguments passed to the polygon compute function
+ */
+declare function benchmarkSight(
+  n: number,
+  ...args: Parameters<typeof ClockwiseSweepPolygon['benchmark']>
+): Promise<void>;

package/src/foundry/client/pixi/groups/index.d.ts

@@ -0,0 +1,3 @@
+import './effects';
+import './interface';
+import './primary';

package/src/foundry/{foundry.js/pixi/containers/cachedContainers/primaryCanvasGroup.d.ts → client/pixi/groups/primary.d.ts}

@@ -26,10 +26,9 @@ declare class PrimaryCanvasGroup extends CachedContainer {
   static groupName: string;
 
   /**
-   * @override
    * @defaultValue `[0, 0, 0, 0]`
    */
-  clearColor: [r: number, g: number, b: number, a: number];
+  override clearColor: [r: number, g: number, b: number, a: number];
 
   /**
    * Create the member layers of the scene container
@@ -37,6 +36,5 @@ declare class PrimaryCanvasGroup extends CachedContainer {
    */
   protected _createLayers(): void;
 
-  /** @override */
-  render(renderer: Parameters<PIXI.Container['render']>[0]): void;
+  override render(renderer: Parameters<PIXI.Container['render']>[0]): void;
 }

package/src/foundry/client/pixi/index.d.ts

@@ -0,0 +1,10 @@
+import './board';
+import './core';
+import './groups';
+import './layer';
+import './layers';
+import './perception';
+import './placeables';
+import './placeables/index';
+import './sources';
+import './webgl';

package/src/foundry/{foundry.js/pixi/containers/canvasLayer.d.ts → client/pixi/layer.d.ts}

@@ -53,8 +53,9 @@ declare abstract class CanvasLayer<Options extends CanvasLayerOptions = CanvasLa
 
   /**
    * Deconstruct data used in the current layer in preparation to re-draw the canvas
+   * @remarks ControlsLayer returns void. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6939
    */
-  tearDown(): Promise<this>;
+  tearDown(): Promise<this | void>;
 
   /**
    * Activate the CanvasLayer, deactivating other layers and marking this layer's children as interactive.

package/src/foundry/{foundry.js/pixi/containers → client/pixi/layers/controls}/cursor.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -22,7 +22,6 @@ declare global {
      */
     protected _animate(): void;
 
-    /** @override */
-    destroy(options?: Parameters<PIXI.Container['destroy']>[0]): void;
+    override destroy(options?: Parameters<PIXI.Container['destroy']>[0]): void;
   }
 }

package/src/foundry/{foundry.js/pixi/containers/doorControl.d.ts → client/pixi/layers/controls/door.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
 
 declare global {
   /**