@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

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

@@ -1,171 +0,0 @@
-/**
- * The base grid class.
- * This double-dips to implement the "gridless" option
- */
-declare class BaseGrid extends PIXI.Container {
-  constructor(options: BaseGrid.GridOptions);
-
-  options: BaseGrid.GridOptions;
-
-  /**
-   * Grid Unit Width
-   */
-  w: number;
-
-  /**
-   * Grid Unit Height
-   */
-  h: number;
-
-  /**
-   * Highlight active grid spaces
-   */
-  highlight: PIXI.Container;
-
-  /**
-   * 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
-   * @param layer   - The highlight layer to use
-   * @param options - (default: `{}`)
-   */
-  highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
-
-  /**
-   * Given a pair of coordinates (x, y) - return the top-left of the grid square which contains that point
-   * @returns An Array [x, y] of the top-left coordinate of the square which contains (x, y)
-   */
-  getTopLeft(x: number, y: number): PointArray;
-
-  /**
-   * Given a pair of coordinates (x, y), return the center of the grid square which contains that point
-   * @param x - The x-coordinate
-   * @param y - The y-coordinate
-   * @returns An array [cx, cy] of the central point of the grid space which contains (x, y)
-   */
-  getCenter(x: number, y: number): PointArray;
-
-  /**
-   * Given a pair of coordinates (x1,y1), return the grid coordinates (x2,y2) which represent the snapped position
-   * Under a "gridless" system, every pixel position is a valid snapping position
-   *
-   * @param x        - The exact target location x
-   * @param y        - The exact target location y
-   * @param interval - An interval of grid spaces at which to snap.
-   *                   At interval=1, snapping occurs at pixel intervals defined by the grid size
-   *                   At interval=2, snapping would occur at the center-points of each grid size
-   *                   At interval=null, no snapping occurs
-   *                   (default: `null`)
-   * @returns An object containing the coordinates of the snapped location
-   */
-  getSnappedPosition(x: number, y: number, interval?: number | null): { x: number; y: number };
-
-  /**
-   * Given a pair of pixel coordinates, return the grid position as an Array.
-   * Always round down to the nearest grid position so the pixels are within the grid space (from top-left).
-   * @param x - The x-coordinate pixel position
-   * @param y - The y-coordinate pixel position
-   * @returns An array representing the position in grid units
-   */
-  getGridPositionFromPixels(x: number, y: number): PointArray;
-
-  /**
-   * Given a pair of grid coordinates, return the pixel position as an Array.
-   * Always round up to a whole pixel so the pixel is within the grid space (from top-left).
-   * @param x - The x-coordinate grid position
-   * @param y - The y-coordinate grid position
-   * @returns An array representing the position in pixels
-   */
-  getPixelsFromGridPosition(x: number, y: number): PointArray;
-
-  /**
-   * Shift a pixel position [x,y] by some number of grid units dx and dy
-   * @param x  - The starting x-coordinate in pixels
-   * @param y  - The starting y-coordinate in pixels
-   * @param dx - The number of grid positions to shift horizontally
-   * @param dy - The number of grid positions to shift vertically
-   */
-  shiftPosition(x: number, y: number, dx: number, dy: number): PointArray;
-
-  /**
-   * Measure the distance traversed over an array of measured segments
-   * @param segments - An Array of measured movement segments
-   * @param options  - Additional options which modify the measurement
-   *                   (default: `{}`)
-   * @returns An Array of distance measurements for each segment
-   */
-  measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions | undefined): number[];
-
-  /**
-   * Get the grid row and column positions which are neighbors of a certain position
-   * @param row - The grid row coordinate against which to test for neighbors
-   * @param col - The grid column coordinate against which to test for neighbors
-   * @returns An array of grid positions which are neighbors of the row and column
-   */
-  getNeighbors(row: number, col: number): PointArray[];
-}
-
-declare namespace BaseGrid {
-  interface GridOptions {
-    dimensions: Canvas['dimensions'];
-    color: string;
-    alpha: Scene['data']['gridAlpha'];
-    columns?: boolean;
-    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
-     */
-    x?: number;
-
-    /**
-     * The y-coordinate of the highlighted position
-     */
-    y?: number;
-
-    /**
-     * The hex fill color of the highlight
-     * @defaultValue `0x33BBFF`
-     */
-    color?: number;
-
-    /**
-     * The hex border color of the highlight
-     * @defaultValue `null`
-     */
-    border?: number | null;
-
-    /**
-     * The opacity of the highlight
-     * @defaultValue `0.25`
-     */
-    alpha?: number;
-
-    /**
-     * A predefined shape to highlight
-     * @defaultValue `null`
-     */
-    shape?: PIXI.Polygon | null;
-  }
-}

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

@@ -1,118 +0,0 @@
-/**
- * Construct a hexagonal grid
- */
-declare class HexagonalGrid extends BaseGrid {
-  constructor(options: BaseGrid.GridOptions);
-
-  columns: boolean;
-
-  even: boolean;
-
-  h: number;
-
-  w: number;
-
-  /**
-   * A matrix of x and y offsets which is multiplied by the width/height vector to get pointy-top polygon coordinates
-   */
-  static get pointyHexPoints(): PointArray[];
-
-  /**
-   * A matrix of x and y offsets which is multiplied by the width/height vector to get flat-top polygon coordinates
-   */
-  static get flatHexPoints(): PointArray[];
-
-  /**
-   * An array of the points which define a hexagon for this grid shape
-   */
-  get hexPoints(): PointArray[];
-
-  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
-   * @param x - The top-left x-coordinate
-   * @param y - The top-right y-coordinate
-   * @param w - An optional polygon width
-   * @param h - An optional polygon height
-   */
-  getPolygon(x: number, y: number, w?: number, h?: number): PointArray[];
-
-  /**
-   * 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;
-
-  /**
-   * Get the position in grid space from a pixel coordinate.
-   * @param x      - The origin x-coordinate
-   * @param y      - The origin y-coordinate
-   * @param method - The rounding method applied
-   *                 (default: `"floor"`)
-   * @returns The row, column combination
-   */
-  getGridPositionFromPixels(x: number, y: number, method?: 'floor' | 'ceil' | 'round'): PointArray;
-
-  override getPixelsFromGridPosition(row: number, col: number): PointArray;
-
-  override getCenter(x: number, y: number): PointArray;
-
-  /**
-   * @param interval - (default: `1`)
-   */
-  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;
-
-  /**
-   * @param options - (default: `{}`)
-   */
-  override highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
-
-  override getNeighbors(row: number, col: number): PointArray[];
-
-  override measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
-
-  /**
-   * Convert an offset coordinate (row, col) into a cube coordinate (q, r, s).
-   * See https://www.redblobgames.com/grids/hexagons/ for reference
-   * Source code available https://www.redblobgames.com/grids/hexagons/codegen/output/lib-functions.js
-   * @param row - The row number
-   * @param col - The column number
-   */
-  offsetToCube(row: number, col: number): { q: number; r: number; s: number };
-
-  /**
-   * Convert a cube coordinate (q, r, s) into an offset coordinate (row, col).
-   * See https://www.redblobgames.com/grids/hexagons/ for reference
-   * Source code available https://www.redblobgames.com/grids/hexagons/codegen/output/lib-functions.js
-   * @param q - Cube coordinate 1
-   * @param r - Cube coordinate 2
-   * @param s - Cube coordinate 3
-   */
-  cubeToOffset(q: number, r: number, s: number): { row: number; col: number };
-
-  /**
-   * Given a cursor position (x, y), obtain the cube coordinate hex (q, r, s) of the hex which contains it
-   * http://justinpombrio.net/programming/2020/04/28/pixel-to-hex.html
-   * @param x - The x-coordinate in pixels
-   * @param y - The y-coordinate in pixels
-   */
-  static pixelToCube(x: number, y: number): [q: number, r: number, s: number];
-
-  /**
-   * Measure the distance in hexagons between two cube coordinates
-   */
-  static cubeDistance(a: { q: number; r: number; s: number }, b: { q: number; r: number; s: number }): number;
-}

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

@@ -1,28 +0,0 @@
-/**
- * A special Graphics class which handles Grid layer highlighting
- */
-declare class GridHighlight extends PIXI.Graphics {
-  constructor(name: string, ...args: ConstructorParameters<typeof PIXI.Graphics>);
-
-  /**
-   * Track the Grid Highlight name
-   */
-  name: string;
-
-  /**
-   * Track distinct positions which have already been highlighted
-   */
-  positions: Set<string>;
-
-  /**
-   * Record a position that is highlighted and return whether or not it should be rendered
-   * @param x - The x-coordinate to highlight
-   * @param y - The y-coordinate to highlight
-   * @returns Whether or not to draw the highlight for this location
-   */
-  highlight(x: number, y: number): boolean;
-
-  override clear(): this;
-
-  override destroy(...args: Parameters<PIXI.Graphics['destroy']>): void;
-}

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

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

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

@@ -1,48 +0,0 @@
-/**
- * Construct a square grid container
- */
-declare class SquareGrid extends BaseGrid {
-  override draw(preview?: BaseGrid.Preview | undefined): this;
-
-  /** @internal */
-  protected _drawLine(
-    points: [x1: number, y1: number, x2: number, y2: number],
-    lineColor: number,
-    lineAlpha: number
-  ): PIXI.Graphics;
-
-  override getCenter(x: number, y: number): PointArray;
-
-  override getGridPositionFromPixels(x: number, y: number): PointArray;
-
-  override getPixelsFromGridPosition(row: number, col: number): PointArray;
-
-  /**
-   * @param interval - (default: `1`)
-   */
-  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
-   * @param x  - The starting x-coordinate in pixels
-   * @param y  - The starting y-coordinate in pixels
-   * @param dx - The number of grid positions to shift horizontally
-   * @param dy - The number of grid positions to shift vertically
-   */
-  shiftPosition(x: number, y: number, dx: number, dy: number): PointArray;
-
-  /** @internal */
-  protected _getNearestVertex(x: number, y: number): PointArray;
-
-  /**
-   * @param options - (default: `{}`)
-   */
-  override highlightGridPosition(layer: GridHighlight, options?: BaseGrid.HighlightGridPositionOptions): void;
-
-  /**
-   * @param options - (default: `{}`)
-   */
-  override measureDistances(segments: GridLayer.Segment[], options?: MeasureDistancesOptions): number[];
-
-  override getNeighbors(row: number, col: number): PointArray[];
-}

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

@@ -1,204 +0,0 @@
-/**
- * A CanvasLayer responsible for drawing a square grid
- */
-declare class GridLayer extends CanvasLayer<GridLayer.LayerOptions> {
-  constructor();
-
-  /**
-   * The Grid container
-   * @defaultValue `undefined`
-   */
-  grid: BaseGrid | undefined;
-
-  /**
-   * The Grid Highlight container
-   * @defaultValue `undefined`
-   */
-  highlight: PIXI.Container | undefined;
-
-  /**
-   * Map named highlight layers
-   * @defaultValue `{}`
-   */
-  highlightLayers: Record<string, GridHighlight>;
-
-  /**
-   * @remarks This is not overridden in foundry but reflects the real behavior.
-   */
-  static get instance(): Canvas['grid'];
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.layerOptions, {
-   *   name: "grid",
-   *   zIndex: 30
-   * }
-   * ```
-   */
-  static override get layerOptions(): GridLayer.LayerOptions;
-
-  /**
-   * The grid type rendered in this Scene
-   */
-  get type(): foundry.CONST.GRID_TYPES;
-
-  /**
-   * A convenient reference to the pixel grid size used throughout this layer
-   */
-  get size(): number;
-
-  /**
-   * Get grid unit width
-   */
-  get w(): BaseGrid['w'];
-
-  /**
-   * Get grid unit height
-   */
-  get h(): BaseGrid['h'];
-
-  /**
-   * A boolean flag for whether the current grid is hexagonal
-   */
-  get isHex(): boolean;
-
-  /**
-   * Draw the grid
-   * @param preview - Override settings used in place of those saved to the Scene data
-   */
-  draw(preview?: DrawOptions): Promise<this>;
-
-  /**
-   * Given a pair of coordinates (x1,y1), return the grid coordinates (x2,y2) which represent the snapped position
-   * @param x        - The exact target location x
-   * @param y        - The exact target location y
-   * @param interval - An interval of grid spaces at which to snap, default is 1. If the interval is zero, no snapping occurs.
-   *                   (defaultValue: `1`)
-   */
-  getSnappedPosition(x: number, y: number, interval?: number): { x: number; y: number };
-
-  /**
-   * Given a pair of coordinates (x, y) - return the top-left of the grid square which contains that point
-   * @returns An Array [x, y] of the top-left coordinate of the square which contains (x, y)
-   */
-  getTopLeft(x: number, y: number): PointArray;
-
-  /**
-   * Given a pair of coordinates (x, y), return the center of the grid square which contains that point
-   * @returns An Array [x, y] of the central point of the square which contains (x, y)
-   */
-  getCenter(x: number, y: number): PointArray;
-
-  /**
-   * 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
-   * ```typescript
-   * let distance = canvas.grid.measureDistance({x: 1000, y: 1000}, {x: 2000, y: 2000});
-   * ```
-   */
-  measureDistance(
-    origin: {
-      x: number;
-      y: number;
-    },
-    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?: MeasureDistancesOptions | undefined): number[];
-
-  /**
-   * Define a new Highlight graphic
-   * @param name - The name for the referenced highlight layer
-   */
-  addHighlightLayer(name: string): GridHighlight;
-
-  /**
-   * Clear a specific Highlight graphic
-   * @param name - The name for the referenced highlight layer
-   */
-  clearHighlightLayer(name: string): void;
-
-  /**
-   * Destroy a specific Highlight graphic
-   * @param name - The name for the referenced highlight layer
-   */
-  destroyHighlightLayer(name: string): void;
-
-  /**
-   * Obtain the highlight layer graphic by name
-   * @param name - The name for the referenced highlight layer
-   */
-  getHighlightLayer(name: string): GridHighlight | undefined;
-
-  /**
-   * Add highlighting for a specific grid position to a named highlight graphic
-   * @param name    - The name for the referenced highlight layer
-   * @param options - Options for the grid position that should be highlighted
-   */
-  highlightPosition(name: string, options?: Parameters<BaseGrid['highlightGridPosition']>[1]): false | void;
-
-  /**
-   * Test if a specific row and column position is a neighboring location to another row and column coordinate
-   * @param r0 - The original row position
-   * @param c0 - The original column position
-   * @param r1 - The candidate row position
-   * @param c1 - The candidate column position
-   */
-  isNeighbor(r0: number, c0: number, r1: number, c1: number): boolean;
-}
-
-declare namespace GridLayer {
-  interface LayerOptions extends CanvasLayer.LayerOptions {
-    name: 'grid';
-    zIndex: 30;
-  }
-
-  interface Segment {
-    ray: Ray;
-    label?: Ruler['labels']['children'][number];
-  }
-}
-
-interface DrawOptions {
-  /**
-   * @defaultValue `null`
-   */
-  type?: foundry.CONST.GRID_TYPES | null;
-
-  /**
-   * @defaultValue `null`
-   */
-  dimensions?: Canvas['dimensions'] | null;
-
-  /**
-   * @defaultValue `null`
-   */
-  gridColor?: number | string | null;
-
-  /**
-   * @defaultValue `null`
-   */
-  gridAlpha?: number | null;
-}
-
-interface MeasureDistancesOptions {
-  /** Return the distance in grid increments rather than the co-ordinate distance. */
-  gridSpaces?: boolean;
-}

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

@@ -1,15 +0,0 @@
-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';