@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client-esm/canvas/edges/edge.d.mts

@@ -1,248 +0,0 @@
-import type PolygonVertex from "./vertex.d.mts";
-import type { LineIntersection } from "@common/utils/geometry.d.mts";
-import type { NullishProps } from "fvtt-types/utils";
-import type { WallThresholdData } from "@common/documents/_types.d.mts";
-
-/**
- * A data structure used to represent potential edges used by the ClockwiseSweepPolygon.
- * Edges are not polygon-specific, meaning they can be reused across many polygon instances.
- */
-declare class Edge {
-  /**
-   * Construct an Edge by providing the following information.
-   * @param a - The first endpoint of the edge
-   * @param b - The second endpoint of the edge
-   * @param options - Additional options which describe the edge
-   */
-  constructor(a: Canvas.Point, b: Canvas.Point, options?: Edge.ConstructorOptions);
-
-  /**
-   * The first endpoint of the edge.
-   */
-  a: PIXI.Point;
-
-  /**
-   * The second endpoint of the edge.
-   */
-  b: PIXI.Point;
-
-  /**
-   * A string used to uniquely identify this edge.
-   * @defaultValue `object?.id ?? undefined`
-   */
-  id: string | undefined;
-
-  /**
-   * A PlaceableObject that is responsible for this edge, if any
-   * @remarks This property is never read by Foundry, so it being nullish won't break anything as of 12.331
-   */
-  object: PlaceableObject.Any | undefined | null;
-
-  /**
-   * The type of edge
-   * @defaultValue `"wall"`
-   */
-  type: Edge.EdgeTypes;
-
-  /**
-   * The direction of effect for the edge.
-   */
-  direction: foundry.CONST.WALL_DIRECTIONS;
-
-  /**
-   * How this edge restricts light.
-   * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-   */
-  light: foundry.CONST.WALL_SENSE_TYPES;
-
-  /**
-   * How this edge restricts movement.
-   * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-   */
-  move: foundry.CONST.WALL_SENSE_TYPES;
-
-  /**
-   * How this edge restricts sight.
-   * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-   */
-  sight: foundry.CONST.WALL_SENSE_TYPES;
-
-  /**
-   * How this edge restricts sound.
-   * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-   */
-  sound: foundry.CONST.WALL_SENSE_TYPES;
-
-  /**
-   * Specialized threshold data for this edge.
-   * @remarks Foundry only accesses this in nullish-safe ways as of 12.331
-   */
-  threshold: WallThresholdData | undefined | null;
-
-  /**
-   * The endpoint of the edge which is oriented towards the top-left.
-   */
-  nw: Canvas.Point;
-
-  /**
-   * The endpoint of the edge which is oriented towards the bottom-right.
-   */
-  se: Canvas.Point;
-
-  /**
-   * The rectangular bounds of the edge. Used by the quadtree.
-   */
-  bounds: PIXI.Rectangle;
-
-  /**
-   * Record other edges which this one intersects with.
-   */
-  intersections: Edge.IntersectionEntry[];
-
-  /**
-   * A PolygonVertex instance.
-   * Used as part of ClockwiseSweepPolygon computation.
-   * @defaultValue `undefined`
-   * @remarks Only set in {@link ClockwiseSweepPolygon#_identifyVertices} (part of CSP initialization)
-   */
-  vertexA: PolygonVertex | undefined;
-
-  /**
-   * A PolygonVertex instance.
-   * Used as part of ClockwiseSweepPolygon computation.
-   * @defaultValue `undefined`
-   * @remarks Only set in {@link ClockwiseSweepPolygon#_identifyVertices} (part of CSP initialization)
-   */
-  vertexB: PolygonVertex | undefined;
-
-  /**
-   * Is this edge limited for a particular type?
-   */
-  isLimited(type: foundry.CONST.WALL_RESTRICTION_TYPES): boolean;
-
-  /**
-   * Create a copy of the Edge which can be safely mutated.
-   */
-  clone(): this;
-
-  /**
-   * Get an intersection point between this Edge and another.
-   */
-  getIntersection(other: Edge): LineIntersection | void;
-
-  /**
-   * Test whether to apply a proximity threshold to this edge.
-   * If the proximity threshold is met, this edge excluded from perception calculations.
-   * @param sourceType     - Sense type for the source
-   * @param sourceOrigin   - The origin or position of the source on the canvas
-   * @param externalRadius - The external radius of the source
-   *                         (default: `0`)
-   * @returns True if the edge has a threshold greater than 0 for the source type,
-   *          and the source type is within that distance.
-   */
-  applyThreshold(sourceType: Edge.AttenuationTypes, sourceOrigin: Canvas.Point, externalRadius?: number): boolean;
-
-  /**
-   * Determine the orientation of this Edge with respect to a reference point.
-   * @param point - Some reference point, relative to which orientation is determined
-   * @returns An orientation in CONST.WALL_DIRECTIONS which indicates whether the Point is left,
-   *          right, or collinear (both) with the Edge
-   */
-  orientPoint(point: Canvas.Point): foundry.CONST.WALL_DIRECTIONS;
-
-  /**
-   * Identify intersections between a provided iterable of edges.
-   * @param edges - An iterable of edges
-   */
-  static identifyEdgeIntersections(edges: Iterable<Edge>): void;
-
-  /**
-   * Record the intersections between two edges.
-   * @param other - Another edge to test and record
-   */
-  recordIntersections(other: Edge): void;
-
-  /**
-   * Remove intersections of this edge with all other edges.
-   */
-  removeIntersections(): void;
-}
-
-declare namespace Edge {
-  interface Any extends AnyEdge {}
-  type AnyConstructor = typeof AnyEdge;
-
-  /** @internal */
-  type _ConstructorOptions = NullishProps<{
-    /**
-     * A string used to uniquely identify this edge
-     *
-     */
-    id: string | null;
-
-    /**
-     * A PlaceableObject that is responsible for this edge, if any
-     * @remarks `Edge#object` is never read by Foundry, so this being nullish won't break anything as of 12.331
-     */
-    object: PlaceableObject.Any;
-
-    /**
-     * The type of edge
-     * @defaultValue `"wall"`
-     */
-    type: Edge.EdgeTypes;
-
-    /**
-     * How this edge restricts light
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-     */
-    light: foundry.CONST.WALL_SENSE_TYPES;
-
-    /**
-     * How this edge restricts movement
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-     */
-    move: foundry.CONST.WALL_SENSE_TYPES;
-
-    /**
-     * How this edge restricts sight
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-     */
-    sight: foundry.CONST.WALL_SENSE_TYPES;
-
-    /**
-     * How this edge restricts sound
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-     */
-    sound: foundry.CONST.WALL_SENSE_TYPES;
-
-    /**
-     * A direction of effect for the edge
-     * @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
-     */
-    direction: foundry.CONST.WALL_DIRECTIONS;
-
-    /**
-     * Configuration of threshold data for this edge
-     * @remarks Foundry only accesses this in nullish-safe ways as of 12.331
-     */
-    threshold: WallThresholdData;
-  }>;
-
-  interface ConstructorOptions extends _ConstructorOptions {}
-
-  type EdgeTypes = "wall" | "darkness" | "innerBounds" | "outerBounds";
-
-  type AttenuationTypes = Exclude<foundry.CONST.WALL_RESTRICTION_TYPES, "move">;
-
-  interface IntersectionEntry {
-    edge: Edge;
-    intersection: LineIntersection;
-  }
-}
-
-declare abstract class AnyEdge extends Edge {
-  constructor(arg0: never, ...args: never[]);
-}
-
-export default Edge;

package/src/foundry/client-esm/canvas/edges/edges.d.mts

@@ -1,32 +0,0 @@
-import type Edge from "./edge.d.mts";
-
-/**
- * A special class of Map which defines all the edges used to restrict perception in a Scene.
- */
-declare class CanvasEdges extends Map<string, Edge> {
-  /**
-   * Initialize all active edges for the Scene. This workflow occurs once only when the Canvas is first initialized.
-   * Edges are created from the following sources:
-   * 1. Wall documents
-   * 2. Canvas boundaries (inner and outer bounds)
-   * 3. Darkness sources
-   * 4. Programmatically defined in the "initializeEdges" hook
-   */
-  initialize(): void;
-
-  /**
-   * Incrementally refresh Edges by computing intersections between all registered edges.
-   */
-  refresh(): void;
-}
-
-declare namespace CanvasEdges {
-  interface Any extends AnyCanvasEdges {}
-  type AnyConstructor = typeof AnyCanvasEdges;
-}
-
-declare abstract class AnyCanvasEdges extends CanvasEdges {
-  constructor(arg0: never, ...args: never[]);
-}
-
-export default CanvasEdges;

package/src/foundry/client-esm/canvas/edges/vertex.d.mts

@@ -1,164 +0,0 @@
-import type { NullishProps } from "../../../../utils/index.d.mts";
-import type Edge from "./edge.d.mts";
-
-/**
- * A specialized point data structure used to represent vertices in the context of the ClockwiseSweepPolygon.
- * This class is not designed or intended for use outside of that context.
- * @internal
- */
-declare class PolygonVertex {
-  constructor(x: number, y: number, options?: PolygonVertex.ConstructorOptions);
-
-  x: number;
-
-  y: number;
-
-  /** @defaultValue `PolygonVertex.getKey(this.x, this.y)` */
-  key: number;
-
-  /**
-   * @defaultValue `undefined`
-   * @remarks Accessed externally in {@link ClockwiseSweepPolygon#_testCollision}
-   */
-  _distance: number | undefined | null;
-
-  /**
-   * @defaultValue `undefined`
-   * @remarks Set to `undefined` in the constructor, otherwise only set externally in `ClockwiseSweepPolygon` methods
-   */
-  _d2: number | undefined;
-
-  /**
-   * @defaultValue `undefined`
-   * @remarks Accessed externally in `ClockwiseSweepPolygon` methods
-   */
-  _index: number | undefined | null;
-
-  /**
-   * Determine the sort key to use for this vertex, arranging points from north-west to south-east.
-   * @param x - The x-coordinate
-   * @param y - The y-coordinate
-   * @returns The key used to identify the vertex
-   */
-  static getKey(x: number, y: number): number;
-
-  /**
-   * 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: Set<Edge>;
-
-  /**
-   * The subset of edges which continue clockwise from this vertex.
-   * @defaultValue `new Set()`
-   */
-  cwEdges: Set<Edge>;
-
-  /**
-   * The subset of edges which continue counter-clockwise from this vertex.
-   * @defaultValue `new Set()`
-   */
-  ccwEdges: Set<Edge>;
-
-  /**
-   * The set of vertices collinear to this vertex
-   * @defaultValue `new Set()`
-   */
-  collinearVertices: Set<PolygonVertex>;
-
-  /**
-   * Is this vertex an endpoint of one or more edges?
-   */
-  isEndpoint: boolean | undefined;
-
-  /**
-   * Does this vertex have a single counterclockwise limiting edge?
-   */
-  isLimitingCCW: boolean | undefined;
-
-  /**
-   * Does this vertex have a single clockwise limiting edge?
-   */
-  isLimitingCW: boolean | undefined;
-
-  /**
-   * Does this vertex have non-limited edges or 2+ limited edges counterclockwise?
-   */
-  isBlockingCCW: boolean | undefined;
-
-  /**
-   * Does this vertex have non-limited edges or 2+ limited edges clockwise?
-   */
-  isBlockingCW: boolean | undefined;
-
-  /**
-   * Does this vertex result from an internal collision?
-   * @defaultValue `false`
-   */
-  isInternal: boolean;
-
-  /**
-   * The maximum restriction imposed by this vertex.
-   * @defaultValue `CONST.WALL_SENSE_TYPES.NONE`
-   * @remarks Actually initialized to `0` literal, but is meant as a `WALL_SENSE_TYPES`
-   */
-  restriction: foundry.CONST.WALL_SENSE_TYPES;
-
-  /**
-   * Record whether this PolygonVertex has been visited in the sweep
-   * @defaultValue `false`
-   * @remarks Set externally during `ClockwiseSweeepPolygon` initialization
-   * @privateRemarks Foundry marked `@internal`
-   */
-  _visited: boolean;
-
-  /**
-   * Is this vertex limited in type?
-   */
-  get isLimited(): boolean;
-
-  /**
-   * Associate an edge with this vertex.
-   * @param edge        - The edge being attached
-   * @param orientation - The orientation of the edge with respect to the origin
-   * @param type        - The restriction type of the polygon being created
-   */
-  attachEdge(edge: Edge, orientation: number, type: foundry.CONST.WALL_RESTRICTION_TYPES): void;
-
-  /**
-   * Is this vertex terminal (at the maximum radius)
-   */
-  get isTerminal(): 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: Canvas.Point, options?: PolygonVertex.ConstructorOptions): PolygonVertex;
-}
-
-declare namespace PolygonVertex {
-  interface Any extends AnyPolygonVertex {}
-  type AnyConstructor = typeof AnyPolygonVertex;
-
-  /** @internal */
-  type _ConstructorOptions = NullishProps<{
-    distance: number;
-    index: number;
-  }>;
-
-  interface ConstructorOptions extends _ConstructorOptions {}
-}
-
-declare abstract class AnyPolygonVertex extends PolygonVertex {
-  constructor(arg0: never, ...args: never[]);
-}
-
-export default PolygonVertex;

package/src/foundry/client-esm/canvas/regions/_module.d.mts

@@ -1,9 +0,0 @@
-// In Foundry itself this file contains re-exports of these other modules.
-// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import-x/extensions */
-
-export { default as RegionGeometry } from "./geometry.mjs";
-export { default as RegionMesh } from "./mesh.mjs";
-export { default as RegionPolygonTree } from "./polygon-tree.mjs";
-export { default as RegionShape } from "./shape.mjs";

package/src/foundry/client-esm/canvas/regions/geometry.d.mts

@@ -1,31 +0,0 @@
-/**
- * The geometry of a {@link Region}.
- * - Vertex Attribute: `aVertexPosition` (`vec2`)
- * - Draw Mode: `PIXI.DRAW_MODES.TRIANGLES`
- */
-declare class RegionGeometry extends PIXI.Geometry {
-  /**
-   * Create a RegionGeometry
-   * @internal
-   */
-  constructor(region: Region.ConfiguredInstance);
-
-  /** The Region this geometry belongs to */
-  get region(): Region.ConfiguredInstance;
-
-  /**
-   * Update the buffers
-   * @internal
-   */
-  protected _clearBuffers(): void;
-
-  /**
-   * Update the buffers
-   * @internal
-   */
-  protected _updateBuffers(): void;
-
-  #regionGeometry: true;
-}
-
-export default RegionGeometry;

package/src/foundry/client-esm/canvas/regions/mesh.d.mts

@@ -1,61 +0,0 @@
-/** A mesh of a {@link Region} */
-declare class RegionMesh extends PIXI.Container {
-  #regionMesh: true;
-
-  /**
-   * Create a RegionMesh
-   * @param region        - The Region to create the RegionMesh from.
-   * @param shaderClass   - The shader class to use. @defaultValue `RegionShader`
-   */
-  constructor(region: Region.ConfiguredInstance, shaderClass?: AbstractBaseShader);
-
-  /** The Region of this RegionMesh */
-  get region(): Region.ConfiguredInstance;
-
-  /** The shader bound to this RegionMesh */
-  get shader(): AbstractBaseShader;
-
-  /** The blend mode assigned tot his RegionMesh */
-  get blendMode(): PIXI.BLEND_MODES;
-  set blendMode(value: PIXI.BLEND_MODES);
-
-  /**
-   * The tint applied to the mesh. This is a hex value.
-   *
-   * A value of 0xFFFFFF will remove any tint effect.
-   * @defaultValue 0xFFFFFF
-   */
-  get tint(): number;
-  set tint(value: number);
-
-  /** The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect. */
-  protected _tintColor: PIXI.Color;
-
-  /**
-   * Cached tint value for the shader uniforms
-   * @internal
-   */
-  protected _cachedTint: [red: number, green: number, blue: number, alpha: number];
-
-  /** Used to track a tint or alpha change to execute a recomputation of _cachedTint. */
-  protected _tintAlphaDirty: boolean;
-
-  /**
-   * Initialize shader based on the shader class type.
-   * @param shaderClass   - The shader class, which must inherit from {@link AbstractBaseShader}.
-   */
-  setShaderClass(shaderClass: typeof AbstractBaseShader): void;
-
-  override updateTransform(): void;
-
-  protected override _render(renderer: PIXI.Renderer): void;
-
-  protected override _calculateBounds(): void;
-
-  /** Tests if a point is indie this RegionMesh */
-  containsPoint(point: PIXI.IPointData): boolean;
-
-  override destroy(options?: PIXI.IDestroyOptions | boolean): void;
-}
-
-export default RegionMesh;

package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts

@@ -1,101 +0,0 @@
-import type { Point } from "@common/_types.d.mts";
-
-/** The node of a {@link RegionPolygonTree}.*/
-declare class RegionPolygonTreeNode {
-  #regionPolygonTreeNode: true;
-
-  /**
-   * Create a RegionPolygonTreeNode.
-   * @param parent    - The parent node.
-   * @internal
-   */
-  constructor(parent: RegionPolygonTreeNode | null);
-
-  /**
-   * Create a node from the Clipper path and add it to the children of the parent.
-   * @param clipperPath   - The clipper path of this node.
-   * @param parent        - The parent node or `null` if root.
-   * @internal
-   */
-  static _fromClipperPath(
-    clipperPath: ClipperLib.IntPoint[],
-    parent: RegionPolygonTreeNode | null,
-  ): RegionPolygonTreeNode;
-
-  /** The parent of this node or `null` if this is the root node. */
-  get parent(): RegionPolygonTreeNode | null;
-
-  /** The children of this node. */
-  get children(): ReadonlyArray<RegionPolygonTreeNode>;
-
-  /**
-   * The depth of this node.
-   * The depth of the root node is 0.
-   */
-  get depth(): number;
-
-  /**
-   * Is this a hole?
-   * The root node is a hole.
-   */
-  get isHole(): boolean;
-
-  /**
-   * The Clipper path of this node.
-   * It is empty in case of the root node.
-   */
-  get clipperPath(): ReadonlyArray<ClipperLib.IntPoint> | null;
-
-  /**
-   * The polygon of this node.
-   * It is `null` in case of the root node.
-   */
-  get polygon(): PIXI.Polygon | null;
-
-  /**
-   * The points of the polygon ([x0, y0, x1, y1, ...]).
-   * They are `null` in case of the root node.
-   */
-  get points(): ReadonlyArray<number> | null;
-
-  /**
-   * The bounds of the polygon.
-   * They are `null` in case of the root node.
-   */
-  get bounds(): PIXI.Rectangle | null;
-
-  [Symbol.iterator](): Generator<RegionPolygonTreeNode>;
-
-  /**
-   * Test whether given point is contained within this node.
-   * @param point     - The point.
-   */
-  testPoint(point: Point): boolean;
-
-  /**
-   * Test circle containment/intersection with this node.
-   * @param center    - The center point of the circle.
-   * @param radius    - The radius of the circle.
-   * @returns         - -1: the circle is in the exterior and does not intersect the boundary.
-   *                  - 0: the circle is intersects the boundary.
-   *                  - 1: the circle is in the interior and does not intersect the boundary.
-   */
-  testCircle(center: Point, radius: number): -1 | 0 | 1;
-}
-
-/** The polygon tree of a {@link Region}. */
-declare class RegionPolygonTree extends RegionPolygonTreeNode {
-  /**
-   * Create a RegionPolygonTree
-   * @internal
-   */
-  constructor();
-
-  /**
-   * Create the tree from a Clipper polygon tree.
-   * @internal
-   */
-  static _fromClipperPolyTree(clipperPolyTree: ClipperLib.PolyTree): RegionPolygonTree;
-}
-
-export default RegionPolygonTree;