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

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

@@ -0,0 +1,117 @@
+/**
+ * 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
+ *
+ * @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;
+
+  // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
+  override get visible(): boolean;
+  override set visible(value: boolean);
+
+  // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
+  override get renderable(): boolean;
+  override 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;
+  }
+}

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,71 +1,77 @@
-/**
- * A CanvasLayer for displaying UI controls which are overlayed on top of other layers.
- *
- * We track three types of events:
- * 1) Cursor movement
- * 2) Ruler measurement
- * 3) Map pings
- */
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
+  /**
+   * A CanvasLayer for displaying UI controls which are overlayed on top of other layers.
+   *
+   * We track three types of events:
+   * 1) Cursor movement
+   * 2) Ruler measurement
+   * 3) Map pings
+   */
   class ControlsLayer extends CanvasLayer<ControlsLayer.LayerOptions> {
     constructor();
 
     /**
-     * Cursor position indicators
-     * @defaultValue `null`
+     * A container of DoorControl instances
+     * @defaultValue `this.addChild(new PIXI.Container())`
      */
-    cursors: PIXI.Container | null;
+    doors: PIXI.Container;
 
     /**
-     * A mapping of user IDs to Cursor instances for quick access
-     * @defaultValue `{}`
-     */
-    protected _cursors: Partial<Record<string, Cursor>>;
-
-    /**
-     * Door control icons
-     * @defaultValue `null`
+     * A container of HUD interface elements
+     * @defaultValue `this.addChild(new PIXI.Container())`
      */
-    doors: PIXI.Container | null;
+    hud: PIXI.Container;
 
     /**
-     * Status effect icons
-     * @remarks Always `null`
+     * A container of cursor interaction elements.
+     * Contains cursors, rulers, interaction rectangles, and pings
+     * @defaultValue `this.addChild(new PIXI.Container())`
      */
-    effects: null;
+    cursors: PIXI.Container;
 
     /**
      * Ruler tools, one per connected user
-     * @defaultValue `null`
+     * @defaultValue `this.addChild(new PIXI.Container())`
      */
-    rulers: PIXI.Container | null;
+    rulers: PIXI.Container;
 
     /**
-     * A convenience mapping of user IDs to Ruler instances for quick access
+     * A graphics instance used for drawing debugging visualization
+     * @defaultValue `this.addChild(new PIXI.Graphics())`
      */
-    protected _rulers: Partial<Record<string, Ruler>>;
+    debug: PIXI.Graphics;
 
     /**
      * Canvas selection rectangle
-     * @defaultValue `null`
+     * @defaultValue `undefined`
      */
-    select: PIXI.Graphics | null;
+    select: PIXI.Graphics | undefined;
 
-    // The controls layer is always interactive
-    interactiveChildren: true;
+    /**
+     * A mapping of user IDs to Cursor instances for quick access
+     * @defaultValue `{}`
+     */
+    protected _cursors: Record<string, Cursor>;
 
     /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
+     * A convenience mapping of user IDs to Ruler instances for quick access
+     * @internal
+     * @defaultValue `{}`
      */
-    static get instance(): undefined;
+    protected _rulers: Record<string, Ruler>;
 
     /**
-     * @override
-     * @defaultValue `mergeObject(super.layerOptions, { name: "controls", zIndex: 1000 })`
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.layerOptions, {
+     *   name: "controls",
+     *   zIndex: 1000
+     * })
+     * ```
      */
-    static get layerOptions(): ControlsLayer.LayerOptions;
+    static override get layerOptions(): ControlsLayer.LayerOptions;
 
     /**
      * A convenience accessor to the Ruler for the active game user
@@ -77,25 +83,17 @@ declare global {
      */
     getRulerForUser(userId: string): Ruler | null;
 
-    /** @override */
-    draw(): this;
+    override draw(): Promise<this>;
 
     /**
-     * Draw the cursors container
+     * @remarks This breaks polymorphism. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6939
      */
-    drawCursors(): void;
+    override tearDown(): Promise<void>;
 
     /**
-     * Draw the Door controls container
-     */
-    drawDoors(): void;
-
-    /**
-     * Create a Door Control icon for a given Wall object
-     * @param wall - The Wall for which to create a DoorControl
-     * @returns The created DoorControl
+     * Draw the cursors container
      */
-    createDoorControl(wall: InstanceType<ConfiguredObjectClassForName<'Wall'>>): ReturnType<DoorControl['draw']> | null;
+    drawCursors(): void;
 
     /**
      * Draw Ruler tools
@@ -108,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
@@ -118,7 +115,7 @@ declare global {
 
     /**
      * Create and draw the Cursor object for a given User
-     * @param user - The User entity for whom to draw the cursor Container
+     * @param user - The User document for whom to draw the cursor Container
      */
     drawCursor(user: InstanceType<ConfiguredDocumentClass<typeof User>>): Cursor;
 

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';