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

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 → 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 {
   /**

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

@@ -1,3 +1,40 @@
+/**
+ * An extension of PIXI.Transform.
+ * This uses a different DisplayObject than the current parent as the reference for the worldTransform.
+ */
+declare class SynchronizedTransform extends PIXI.Transform {
+  constructor(transform: PIXI.Transform);
+
+  /**
+   * A list of attributes from the transform reference which should be synchronized
+   * @defaultValue
+   * ```javascript
+   * [
+   *   "localTransform", "position", "scale", "pivot", "skew", "_rotation",
+   *   "_cx", "_sx", "_cy", "_sy", "_localID", "_currentLocalID"
+   * ];
+   * ```
+   */
+  static synchronizedAttributes: string[];
+
+  /**
+   * A Transform instance which defines the reference point for the worldTransform
+   */
+  get reference(): PIXI.Transform;
+
+  set reference(value: PIXI.Transform);
+
+  /** @internal */
+  protected _reference: PIXI.Transform;
+
+  /** @internal */
+  protected _syncLocalID: number;
+
+  override updateTransform(parentTransform: PIXI.Transform): void;
+
+  override updateLocalTransform(): void;
+}
+
 /**
  * An extension of PIXI.Container used as the interface frame for a PlaceableObject on the ControlsLayer
  *
@@ -17,15 +54,13 @@ declare class ObjectHUD extends PIXI.Container {
    */
   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 get visible(): boolean;
+  override 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);
+  override get renderable(): boolean;
+  override set renderable(value: boolean);
 
   /**
    * Display scrolling status text originating from this ObjectHUD container.

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

@@ -0,0 +1,4 @@
+import './cursor';
+import './door';
+import './hud';
+import './ruler';

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

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
 
 declare global {
   interface RulerData {

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

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -63,7 +63,6 @@ declare global {
     protected _rulers: Record<string, Ruler>;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.layerOptions, {
@@ -72,7 +71,7 @@ declare global {
      * })
      * ```
      */
-    static get layerOptions(): ControlsLayer.LayerOptions;
+    static override get layerOptions(): ControlsLayer.LayerOptions;
 
     /**
      * A convenience accessor to the Ruler for the active game user
@@ -84,14 +83,12 @@ declare global {
      */
     getRulerForUser(userId: string): Ruler | null;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
     /**
-     * @override
      * @remarks This breaks polymorphism. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6939
      */
-    tearDown(): Promise<void>;
+    override tearDown(): Promise<void>;
 
     /**
      * Draw the cursors container
@@ -109,8 +106,7 @@ declare global {
      */
     drawSelect({ x, y, width, height }: { x: number; y: number; width: number; height: number }): void;
 
-    /** @override */
-    deactivate(): void;
+    override deactivate(): void;
 
     /**
      * Handle mousemove events on the game canvas to broadcast activity of the user's cursor position

package/src/foundry/{foundry.js/pixi/containers/canvasLayers/placeablesLayers/drawingsLayer.d.ts → client/pixi/layers/drawings.d.ts}

@@ -9,7 +9,6 @@ declare class DrawingsLayer extends PlaceablesLayer<'Drawing', DrawingsLayer.Lay
   static get instance(): Canvas['drawings'];
 
   /**
-   * @override
    * @defaultValue
    * ```
    * mergeObject(super.layerOptions, {
@@ -21,10 +20,9 @@ declare class DrawingsLayer extends PlaceablesLayer<'Drawing', DrawingsLayer.Lay
    * })
    * ```
    */
-  static get layerOptions(): DrawingsLayer.LayerOptions;
+  static override get layerOptions(): DrawingsLayer.LayerOptions;
 
-  /** @override */
-  static documentName: 'Drawing';
+  static override documentName: 'Drawing';
 
   /**
    * The named game setting which persists default drawing configuration for the User
@@ -36,8 +34,7 @@ declare class DrawingsLayer extends PlaceablesLayer<'Drawing', DrawingsLayer.Lay
    */
   get gridPrecision(): 0 | 8 | 16;
 
-  /** @override */
-  get hud(): Exclude<Canvas['hud'], null>['drawing'];
+  override get hud(): Exclude<Canvas['hud'], null>['drawing'];
 
   /**
    * Render a configuration sheet to configure the default Drawing settings
@@ -59,28 +56,22 @@ declare class DrawingsLayer extends PlaceablesLayer<'Drawing', DrawingsLayer.Lay
    */
   _getNewDrawingData(origin: Point | {}): NewDrawingData;
 
-  /** @override */
-  protected _onClickLeft(event: PIXI.InteractionEvent): void;
+  protected override _onClickLeft(event: PIXI.InteractionEvent): void;
 
-  /** @override */
-  protected _onClickLeft2(event: PIXI.InteractionEvent): void | Promise<void>;
+  protected override _onClickLeft2(event: PIXI.InteractionEvent): void | Promise<void>;
 
-  /** @override */
-  protected _onDragLeftStart(event: PIXI.InteractionEvent): ReturnType<Drawing['draw']>;
+  protected override _onDragLeftStart(event: PIXI.InteractionEvent): ReturnType<Drawing['draw']>;
 
-  /** @override */
-  protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
+  protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
 
   /**
    * Handling of mouse-up events which conclude a new object creation after dragging
    */
   protected _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<void>;
 
-  /** @override */
-  protected _onDragLeftCancel(event: PointerEvent): void;
+  protected override _onDragLeftCancel(event: PointerEvent): void;
 
-  /** @override */
-  protected _onClickRight(event: PIXI.InteractionEvent): void;
+  protected override _onClickRight(event: PIXI.InteractionEvent): void;
 }
 
 declare namespace DrawingsLayer {

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

@@ -0,0 +1,4 @@
+import './effect';
+import './leaves';
+import './rain';
+import './snow';

package/src/foundry/{foundry.js/pixi/containers/canvasLayers/weatherLayer.d.ts → client/pixi/layers/effects.d.ts}

@@ -42,11 +42,9 @@ declare class WeatherLayer extends CanvasLayer<WeatherLayer.LayerOptions> {
    */
   static get layerOptions(): WeatherLayer.LayerOptions;
 
-  /** @override */
-  tearDown(): Promise<this>;
+  override tearDown(): Promise<this>;
 
-  /** @override */
-  draw(): Promise<undefined>;
+  override draw(): Promise<undefined>;
 
   /**
    * Draw the weather container.

package/src/foundry/{foundry.js/pixi/containers/baseGrids/hexagonalGrid.d.ts → client/pixi/layers/grid/hex.d.ts}

@@ -27,8 +27,7 @@ declare class HexagonalGrid extends BaseGrid {
    */
   get hexPoints(): PointArray[];
 
-  /** @override */
-  draw(preview?: BaseGrid.Preview | undefined): this;
+  override draw(preview?: BaseGrid.Preview | undefined): this;
 
   /**
    * A convenience method for getting all the polygon points relative to a top-left [x,y] coordinate pair
@@ -62,35 +61,28 @@ declare class HexagonalGrid extends BaseGrid {
    */
   getGridPositionFromPixels(x: number, y: number, method?: 'floor' | 'ceil' | 'round'): PointArray;
 
-  /** @override */
-  getPixelsFromGridPosition(row: number, col: number): PointArray;
+  override getPixelsFromGridPosition(row: number, col: number): PointArray;
 
-  /** @override */
-  getCenter(x: number, y: number): PointArray;
+  override getCenter(x: number, y: number): PointArray;
 
   /**
-   * @override
    * @param interval - (default: `1`)
    */
-  getSnappedPosition(x: number, y: number, interval?: number | null): { x: number; y: number };
+  override getSnappedPosition(x: number, y: number, interval?: number | null): { 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;
+  override shiftPosition(x: number, y: number, dx: number, dy: number): PointArray;
 
   /**
-   * @override
    * @param options - (default: `{}`)
    */
-  highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
+  override highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
 
-  /** @override */
-  getNeighbors(row: number, col: number): PointArray[];
+  override getNeighbors(row: number, col: number): PointArray[];
 
-  /** @override */
-  measureDistances(segments: GridLayer.Segment[], options?: 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/graphics/gridHighlight.d.ts → client/pixi/layers/grid/highlight.d.ts}

@@ -22,9 +22,7 @@ declare class GridHighlight extends PIXI.Graphics {
    */
   highlight(x: number, y: number): boolean;
 
-  /** @override */
-  clear(): this;
+  override clear(): this;
 
-  /** @override */
-  destroy(...args: Parameters<PIXI.Graphics['destroy']>): void;
+  override destroy(...args: Parameters<PIXI.Graphics['destroy']>): void;
 }

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

@@ -0,0 +1,4 @@
+import './grid';
+import './hex';
+import './highlight';
+import './square';

package/src/foundry/{foundry.js/pixi/containers/baseGrids/squareGrid.d.ts → client/pixi/layers/grid/square.d.ts}

@@ -2,8 +2,7 @@
  * Construct a square grid container
  */
 declare class SquareGrid extends BaseGrid {
-  /** @override */
-  draw(preview?: BaseGrid.Preview | undefined): this;
+  override draw(preview?: BaseGrid.Preview | undefined): this;
 
   /** @internal */
   protected _drawLine(
@@ -12,20 +11,16 @@ declare class SquareGrid extends BaseGrid {
     lineAlpha: number
   ): PIXI.Graphics;
 
-  /** @override */
-  getCenter(x: number, y: number): PointArray;
+  override getCenter(x: number, y: number): PointArray;
 
-  /** @override */
-  getGridPositionFromPixels(x: number, y: number): PointArray;
+  override getGridPositionFromPixels(x: number, y: number): PointArray;
 
-  /** @override */
-  getPixelsFromGridPosition(row: number, col: number): PointArray;
+  override getPixelsFromGridPosition(row: number, col: number): PointArray;
 
   /**
-   * @override
    * @param interval - (default: `1`)
    */
-  getSnappedPosition(x: number, y: number, interval?: number | null): { x: number; y: number };
+  override getSnappedPosition(x: number, y: number, interval?: number | null): { x: number; y: number };
 
   /**
    * Shift a pixel position [x,y] by some number of grid units dx and dy
@@ -40,17 +35,14 @@ declare class SquareGrid extends BaseGrid {
   protected _getNearestVertex(x: number, y: number): PointArray;
 
   /**
-   * @override
    * @param options - (default: `{}`)
    */
-  highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
+  override highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
 
   /**
-   * @override
    * @param options - (default: `{}`)
    */
-  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
+  override measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
 
-  /** @override */
-  getNeighbors(row: number, col: number): PointArray[];
+  override getNeighbors(row: number, col: number): PointArray[];
 }

package/src/foundry/{foundry.js/pixi/containers/canvasLayers/gridLayer.d.ts → client/pixi/layers/grid.d.ts}

@@ -28,7 +28,6 @@ declare class GridLayer extends CanvasLayer<GridLayer.LayerOptions> {
   static get instance(): Canvas['grid'];
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * mergeObject(super.layerOptions, {
@@ -37,7 +36,7 @@ declare class GridLayer extends CanvasLayer<GridLayer.LayerOptions> {
    * }
    * ```
    */
-  static get layerOptions(): GridLayer.LayerOptions;
+  static override get layerOptions(): GridLayer.LayerOptions;
 
   /**
    * The grid type rendered in this Scene

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

@@ -0,0 +1,15 @@
+import './controls';
+import './controls/index';
+import './drawings';
+import './effects';
+import './effects/index';
+import './grid';
+import './grid/index';
+import './lighting';
+import './map';
+import './notes';
+import './sight';
+import './sounds';
+import './templates';
+import './tokens';
+import './walls';

package/src/foundry/{foundry.js/pixi/containers/canvasLayers/placeablesLayers/lightingLayer.d.ts → client/pixi/layers/lighting.d.ts}

@@ -71,8 +71,7 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
    */
   channels: ChannelConfig | undefined;
 
-  /** @override */
-  static documentName: 'AmbientLight';
+  static override documentName: 'AmbientLight';
 
   /**
    * @remarks This is not overridden in foundry but reflects the real behavior.
@@ -80,7 +79,6 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
   static get instance(): Canvas['lighting'];
 
   /**
-   * @override
    * @defaultValue
    * ```
    * foundry.utils.mergeObject(super.layerOptions, {
@@ -90,7 +88,7 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
    * })
    * ```
    */
-  static get layerOptions(): LightingLayer.LayerOptions;
+  static override get layerOptions(): LightingLayer.LayerOptions;
 
   /**
    * TODO: Significant portions of this method may no longer be needed
@@ -108,10 +106,7 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
     backgroundColor?: number;
   }): ChannelConfig;
 
-  /**
-   * @override
-   */
-  draw(): Promise<this>;
+  override draw(): Promise<this>;
 
   masks?: PIXI.Container;
 
@@ -162,8 +157,7 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
     backgroundColor?: number;
   }): void;
 
-  /** @override */
-  tearDown(): Promise<this>;
+  override tearDown(): Promise<this>;
 
   /**
    * Activate light source animation for AmbientLight objects within this layer
@@ -210,17 +204,13 @@ declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLaye
    */
   protected _onDarknessChange(darkness: number, prior: number): void;
 
-  /** @override */
-  protected _onDragLeftStart(event: PIXI.InteractionEvent): Promise<AmbientLight>;
+  protected override _onDragLeftStart(event: PIXI.InteractionEvent): Promise<AmbientLight>;
 
-  /** @override */
-  protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
+  protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
 
-  /** @override */
-  protected _onDragLeftCancel(event: PointerEvent): void;
+  protected override _onDragLeftCancel(event: PointerEvent): void;
 
-  /** @override */
-  protected _onMouseWheel(event: WheelEvent): void | ReturnType<AmbientLight['rotate']>;
+  protected override _onMouseWheel(event: WheelEvent): void | ReturnType<AmbientLight['rotate']>;
 }
 
 declare namespace LightingLayer {