fvtt-types/src/foundry/common/grid/grid-hex.d.mts

TypeScript type definitions for Foundry VTT

import type HexagonalGrid from "./hexagonal.mjs";
import type { Canvas } from "#client/canvas/_module.d.mts";

/**
 * A helper class which represents a single hexagon as part of a HexagonalGrid.
 * This class relies on having an active canvas scene in order to know the configuration of the hexagonal grid.
 */
declare class GridHex {
  /**
   * Construct a GridHex instance by providing a hex coordinate.
   * @param coordinates - The coordinates of the hex to construct
   * @param grid        - The hexagonal grid instance to which this hex belongs
   */
  constructor(coordinates: HexagonalGrid.Coordinates, grid: HexagonalGrid);

  /** The hexagonal grid to which this hex belongs. */
  grid: HexagonalGrid;

  /** The cube coordinate of this hex. */
  cube: HexagonalGrid.Cube;

  /** The offset coordinate of this hex. */
  offset: HexagonalGrid.Offset;

  /** Return a reference to the pixel point in the center of this hexagon. */
  get center(): Canvas.Point;

  /** Return a reference to the pixel point of the top-left corner of this hexagon. */
  get topLeft(): Canvas.Point;

  /**
   * Return the array of hexagons which are neighbors of this one.
   * This result is un-bounded by the confines of the game canvas and may include hexes which are off-canvas.
   */
  getNeighbors(): GridHex[];

  /**
   * Get a neighboring hex by shifting along cube coordinates
   * @param dq - A number of hexes to shift along the q axis
   * @param dr - A number of hexes to shift along the r axis
   * @param ds - A number of hexes to shift along the s axis
   * @returns The shifted hex
   */
  shiftCube(dq: number, dr: number, ds: number): GridHex;

  /**
   * Return whether this GridHex equals the same position as some other GridHex instance.
   * @param other- Some other GridHex
   * @returns Are the positions equal?
   */
  equals(other: GridHex): boolean;
}

declare namespace GridHex {}

export default GridHex;