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

package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts

@@ -1,198 +0,0 @@
-import type { FixedInstanceType, Mixin } from "fvtt-types/utils";
-import type Document from "../../../../common/abstract/document.d.mts";
-
-declare class PrimaryCanvasObject {
-  /** @privateRemarks All mixin classses should accept anything for its constructor. */
-  constructor(...args: any[]);
-
-  /**
-   * @defaultValue `true`
-   * @privateRemarks Actually an override of the property on `PIXI.DisplayObject`
-   */
-  cullable: boolean;
-
-  /**
-   * An optional reference to the object that owns this PCO.
-   * This property does not affect the behavior of the PCO itself.
-   * @defaultValue `null`
-   * @privateRemarks Foundry types as `*`, but in practice, it will only ever be a `Drawing` (via `PrimaryGraphics`),
-   * or a `Token`, `Tile`, or the `PrimaryCanvasGroup` (via `PrimarySpriteMesh`), or its default value `null`
-   */
-  //TODO: (esheyw) Revisit the "any canvas group" type when groups are done
-  object: PlaceableObject.Any | CanvasGroupMixin.AnyMixed | null;
-
-  /**
-   * The elevation of this object.
-   * @defaultValue `0`
-   */
-  get elevation(): number;
-
-  set elevation(value);
-
-  /**
-   * A key which resolves ties amongst objects at the same elevation within the same layer.
-   */
-  get sort(): number;
-
-  set sort(value);
-
-  /**
-   * A key which resolves ties amongst objects at the same elevation of different layers.
-   */
-  get sortLayer(): number;
-
-  set sortLayer(value);
-
-  /**
-   * A key which resolves ties amongst objects at the same elevation within the same layer and same sort.
-   */
-  get zIndex(): number;
-
-  set zIndex(value);
-
-  /**
-   * Event fired when this display object is added to a parent.
-   * @param parent - The new parent container.
-   * @throws If `parent` is not `=== canvas.primary`
-   */
-  protected _onAdded(parent: PIXI.Container): void;
-
-  /**
-   * Event fired when this display object is removed from its parent.
-   * @param parent - Parent from which the PCO is removed.
-   */
-  protected _onRemoved(parent: PIXI.Container): void;
-
-  /** @see {@link CanvasTransformMixinClass#updateCanvasTransform} */
-  updateCanvasTransform(): void;
-
-  /** @see {@link CanvasTransformMixinClass#_onCanvasBoundsUpdate} */
-  protected _onCanvasBoundsUpdate(): void;
-
-  /**
-   * Does this object render to the depth buffer?
-   */
-  get shouldRenderDepth(): boolean;
-
-  /**
-   * Does this object render to the depth buffer?
-   */
-  protected _shouldRenderDepth(): boolean;
-
-  /**
-   * Render the depth of this object.
-   */
-  renderDepthData(renderer: PIXI.Renderer): void;
-
-  /**
-   * @deprecated since v11, will be removed in v13
-   * @remarks `"PrimaryCanvasObject#renderOcclusion is deprecated in favor of PrimaryCanvasObject#renderDepthData"`
-   */
-  renderOcclusion(renderer: PIXI.Renderer): void;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"PrimaryCanvasObject#document is deprecated."`
-   */
-  get document(): Document.Any | null;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"PrimaryCanvasObject#updateBounds is deprecated and has no effect."`
-   */
-  updateBounds(): void;
-}
-
-declare class CanvasTransformMixinClass {
-  /** @privateRemarks All mixin classses should accept anything for its constructor. */
-  constructor(...args: any[]);
-
-  /**
-   * The transform matrix from local space to canvas space.
-   */
-  canvasTransform: PIXI.Matrix;
-
-  /**
-   * The update ID of canvas transform matrix.
-   * @privateRemarks Foundry marked `@internal`, technically accessed externally via `this.parent._convasTranformID` in `updateCanvasTransform`
-   */
-  protected _canvasTransformID: number;
-
-  /**
-   * The canvas bounds of this object.
-   */
-  canvasBounds: PIXI.Rectangle;
-
-  /**
-   * The canvas bounds of this object.
-   */
-  protected _canvasBounds: PIXI.Bounds;
-
-  /**
-   * The update ID of the canvas bounds.
-   * Increment to force recalculation.
-   */
-  protected _canvasBoundsID: number;
-
-  /**
-   * Calculate the canvas bounds of this object.
-   */
-  protected _calculateCanvasBounds(): void;
-
-  /**
-   * Recalculate the canvas transform and bounds of this object and its children, if necessary.
-   */
-  updateCanvasTransform(): void;
-
-  /**
-   * Called when the canvas transform changed.
-   */
-  protected _onCanvasTransformUpdate(): void;
-
-  /**
-   * Called when the canvas bounds changed.
-   */
-  protected _onCanvasBoundsUpdate(): void;
-
-  /**
-   * Is the given point in canvas space contained in this object?
-   * @param point - The point in canvas space.
-   */
-  containsCanvasPoint(point: PIXI.IPointData): boolean;
-}
-
-declare global {
-  /**
-   * A mixin which decorates a DisplayObject with additional properties expected for rendering in the PrimaryCanvasGroup.
-   * @param DisplayObject - The parent DisplayObject class being mixed
-   * @returns A DisplayObject subclass mixed with PrimaryCanvasObject features
-   * @privateRemarks Despite naming the argument "DisplayObject", it's typed as only taking `PIXI.Container`s, which matches core's usage
-   */
-  function PrimaryCanvasObjectMixin<BaseClass extends PrimaryCanvasObjectMixin.BaseClass>(
-    DisplayObject: BaseClass,
-  ): Mixin<typeof PrimaryCanvasObject, ReturnType<typeof CanvasTransformMixin<BaseClass>>>;
-
-  namespace PrimaryCanvasObjectMixin {
-    type AnyMixedConstructor = ReturnType<typeof PrimaryCanvasObjectMixin<PrimaryCanvasObjectMixin.BaseClass>>;
-    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
-
-    type BaseClass = PIXI.Container.AnyConstructor;
-  }
-
-  /**
-   * A mixin which decorates a DisplayObject with additional properties for canvas transforms and bounds.
-   * @param DisplayObject - The parent DisplayObject class being mixed
-   * @returns A DisplayObject subclass mixed with CanvasTransformMixin features
-   * @privateRemarks Despite naming the argument "DisplayObject", it's typed as only taking `PIXI.Container`s, which matches core's usage
-   */
-  function CanvasTransformMixin<BaseClass extends CanvasTransformMixin.BaseClass>(
-    DisplayObject: BaseClass,
-  ): Mixin<typeof CanvasTransformMixinClass, BaseClass>;
-
-  namespace CanvasTransformMixin {
-    type AnyMixedConstructor = ReturnType<typeof CanvasTransformMixin<CanvasTransformMixin.BaseClass>>;
-    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
-
-    type BaseClass = PIXI.Container.AnyConstructor;
-  }
-}

package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts

@@ -1,60 +0,0 @@
-import type { NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A basic PCO which is handling drawings of any shape.
-   */
-  class PrimaryGraphics extends PrimaryCanvasObjectMixin(PIXI.Graphics) {
-    /**
-     * @param options - A config object
-     */
-    constructor(
-      /**
-       * @remarks Passing `null`, or an object where the `geometry` property is either missing or nullish, will result in an effective default of `new PIXI.GraphicsGeometry()`
-       */
-      options?: PIXI.GraphicsGeometry | PrimaryGraphics.ConstructorOptions | null,
-    );
-
-    override _calculateCanvasBounds(): void;
-
-    override updateCanvasTransform(): void;
-
-    override containsCanvasPoint(point: PIXI.IPointData): boolean;
-  }
-
-  namespace PrimaryGraphics {
-    interface Any extends AnyPrimaryGraphics {}
-    type AnyConstructor = typeof AnyPrimaryGraphics;
-
-    /** @internal */
-    type _ConstructorOptions = NullishProps<{
-      /**
-       * A geometry passed to the graphics.
-       * @defaultValue `new PIXI.GraphicsGeometry()`
-       * @remarks Default via calling `super(geometry)` with a falsey value
-       */
-      geometry: PIXI.GraphicsGeometry;
-
-      /**
-       * The name of the PCO.
-       * @defaultValue `null`
-       * @remarks Default via `?? null` in function body
-       * */
-      name: string;
-
-      /**
-       * Any object that owns this PCO.
-       * @defaultValue `null`
-       * @remarks Default via `?? null` in function body
-       * @privateRemarks Foundry types as `*`, but the only place they use this class is for `Drawing`s
-       */
-      object: PlaceableObject.Any;
-    }>;
-
-    interface ConstructorOptions extends _ConstructorOptions {}
-  }
-}
-
-declare abstract class AnyPrimaryGraphics extends PrimaryGraphics {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts

@@ -1,202 +0,0 @@
-import type { FixedInstanceType, Mixin, NullishProps } from "fvtt-types/utils";
-
-declare class PrimaryOccludableObject {
-  /** @privateRemarks All mixin classses should accept anything for its constructor. */
-  constructor(...args: any[]);
-
-  /**
-   * Is this occludable object hidden for Gamemaster visibility only?
-   * @defaultValue `false`
-   */
-  hidden: boolean;
-
-  /**
-   * A flag which tracks whether the primary canvas object is currently in an occluded state.
-   * @defaultValue `false`
-   */
-  occluded: boolean;
-
-  /**
-   * The occlusion mode of this occludable object.
-   * @defaultValue `CONST.OCCLUSION_MODES.NONE`
-   */
-  occlusionMode: CONST.OCCLUSION_MODES;
-
-  /**
-   * The unoccluded alpha of this object.
-   * @defaultValue `1`
-   */
-  unoccludedAlpha: number;
-
-  /**
-   * The occlusion alpha of this object.
-   * @defaultValue `0`
-   */
-  occludedAlpha: number;
-
-  /**
-   * Fade this object on hover?
-   * @defaultValue `true`
-   */
-  get hoverFade(): boolean;
-
-  set hoverFade(value);
-
-  /**
-   * The amount of rendered FADE, RADIAL, and VISION occlusion.
-   * @defaultValue
-   * ```js
-   * {
-   *   fade: 0.0,
-   *   radial: 0.0,
-   *   vision: 0.0
-   * }
-   * ```
-   * @privateRemarks Foundry marked `@internal`
-   */
-  _occlusionState: PrimaryOccludableObjectMixin.OcclusionState;
-
-  /**
-   * The state of hover-fading.
-   * @defaultValue
-   * ```js
-   * {
-   *   hovered: false,
-   *   hoveredTime: 0,
-   *   faded: false,
-   *   fading: false,
-   *   fadingTime: 0,
-   *   occlusion: 0.0
-   * }
-   * ```
-   * @privateRemarks Foundry marked `@internal`
-   */
-  _hoverFadeState: PrimaryOccludableObjectMixin.HoverFadeState;
-
-  /**
-   * Get the blocking option bitmask value.
-   * @privateRemarks Foundry marked `@internal`
-   */
-  get _restrictionState(): number;
-
-  /**
-   * Is this object blocking light?
-   */
-  get restrictsLight(): boolean;
-
-  set restrictsLight(enabled);
-
-  /**
-   * Is this object blocking weather?
-   */
-  get restrictsWeather(): boolean;
-
-  set restrictsWeather(enabled);
-
-  /**
-   * Is this occludable object... occludable?
-   */
-  get isOccludable(): boolean;
-
-  /**
-   * Debounce assignment of the PCO occluded state to avoid cases like animated token movement which can rapidly
-   * change PCO appearance.
-   * Uses a 50ms debounce threshold.
-   * Objects which are in the hovered state remain occluded until their hovered state ends.
-   * @remarks Actually the return value of an arrow function passed to `foundry.utils.debounce` with a timeout of 50ms
-   */
-  debounceSetOcclusion: (occluded: boolean) => boolean;
-
-  updateCanvasTransform(): void;
-
-  _shouldRenderDepth(): boolean;
-
-  /**
-   * Test whether a specific Token occludes this PCO.
-   * Occlusion is tested against 9 points, the center, the four corners-, and the four cardinal directions
-   * @param token   - The Token to test
-   * @param options - Additional options that affect testing
-   * @returns Is the Token occluded by the PCO?
-   */
-  testOcclusion(token: Token.ConfiguredInstance, options?: PrimaryOccludableObjectMixin.TestOcclusionOptions): boolean;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks "`#roof` is deprecated in favor of more granular options: `#restrictsLight` and `#restrictsWeather`"
-   */
-  get roof(): boolean;
-
-  /**
-   * @deprecated since v12, until v14
-   * @remarks "#roof is deprecated in favor of more granular options: #restrictsLight and #restrictsWeather"
-   */
-  set roof(enabled);
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks "#containsPixel is deprecated. Use #containsCanvasPoint instead."
-   */
-  containsPixel(x: number, y: number, alphaThreshold?: number): boolean;
-
-  /**
-   * @deprecated since v11, will be removed in v13
-   * @remarks "PrimaryCanvasObject#renderOcclusion is deprecated in favor of PrimaryCanvasObject#renderDepth"
-   */
-  renderOcclusion(renderer: PIXI.Renderer): void;
-}
-
-declare global {
-  function PrimaryOccludableObjectMixin<BaseClass extends PrimaryOccludableObjectMixin.BaseClass>(
-    DisplayObject: BaseClass,
-  ): Mixin<typeof PrimaryOccludableObject, ReturnType<typeof PrimaryCanvasObjectMixin<BaseClass>>>;
-
-  namespace PrimaryOccludableObjectMixin {
-    type AnyMixedConstructor = ReturnType<typeof PrimaryOccludableObjectMixin<BaseClass>>;
-    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
-
-    type BaseClass = PIXI.Container.AnyConstructor;
-
-    /** @internal */
-    type _TestOcclusionOptions = NullishProps<{
-      /**
-       * Test corners of the hit-box in addition to the token center?
-       * @defaultValue `0`
-       */
-      corners: boolean;
-    }>;
-
-    /** Additional options that affect testing */
-    interface TestOcclusionOptions extends _TestOcclusionOptions {}
-
-    interface OcclusionState {
-      /** The amount of FADE occlusion */
-      fade: number;
-
-      /** The amount of RADIAL occlusion */
-      radial: number;
-
-      /** The amount of VISION occlusion */
-      vision: number;
-    }
-
-    interface HoverFadeState {
-      /** The hovered state */
-      hovered: boolean;
-
-      /** The last time when a mouse event was hovering this object */
-      hoveredTime: number;
-
-      /** The faded state */
-      faded: boolean;
-
-      /** The fading state */
-      fading: boolean;
-
-      /** The time the fade animation started */
-      fadingTime: number;
-
-      /** The amount of occlusion */
-      occlusion: number;
-    }
-  }
-}

package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts

@@ -1,194 +0,0 @@
-import type { InexactPartial, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A basic PCO sprite mesh which is handling occlusion and depth.
-   */
-  class PrimarySpriteMesh extends PrimaryOccludableObjectMixin(SpriteMesh) {
-    constructor(
-      /**
-       * The constructor options.
-       * @defaultValue `{}`
-       * @remarks Default is applied if `options` is `instanceof PIXI.Texture`, or neither that nor `instanceof Object`
-       */
-      options?: PrimarySpriteMesh.ConstructorOptions | PIXI.Texture | null,
-      /**
-       * The shader class used to render this sprite.
-       * @defaultValue `PrimaryBaseSamplerShader`
-       * @remarks If `options` is an object, `options.shaderClass` takes precedence. If omitted,
-       * or if `options` is a `PIXI.Texture`, default is provided by `??` in function body.
-       */
-      shaderClass?: PrimaryBaseSamplerShader.AnyConstructor | null,
-    );
-
-    /**
-     * The texture alpha data.
-     */
-    protected _textureAlphaData: TextureLoader.TextureAlphaData | null;
-
-    /**
-     * The texture alpha threshold used for point containment tests.
-     * If set to a value larger than 0, the texture alpha data is
-     * extracted from the texture at 25% resolution.
-     * @defaultValue `0`
-     */
-    textureAlphaThreshold: number;
-
-    override _onTextureUpdate(): void;
-
-    override setShaderClass(shaderClass: PrimaryBaseSamplerShader.AnyConstructor): void;
-
-    /**
-     * An all-in-one helper method: Resizing the PCO according to desired dimensions and options.
-     * This helper computes the width and height based on the following factors:
-     *
-     * - The ratio of texture width and base width.
-     * - The ratio of texture height and base height.
-     *
-     * Additionally, It takes into account the desired fit options:
-     *
-     * - (default) "fill" computes the exact width and height ratio.
-     * - "cover" takes the maximum ratio of width and height and applies it to both.
-     * - "contain" takes the minimum ratio of width and height and applies it to both.
-     * - "width" applies the width ratio to both width and height.
-     * - "height" applies the height ratio to both width and height.
-     *
-     * You can also apply optional scaleX and scaleY options to both width and height. The scale is applied after fitting.
-     *
-     * **Important**: By using this helper, you don't need to set the height, width, and scale properties of the DisplayObject.
-     *
-     * **Note**: This is a helper method. Alternatively, you could assign properties as you would with a PIXI DisplayObject.
-     * @param baseWidth  - The base width used for computations.
-     * @param baseHeight - The base height used for computations.
-     * @param options    - The options.
-     * @throws If either `baseWidth` or `baseHeight` are less than 0, or if `options.fit` is not a FitType
-     */
-    resize(baseWidth: number, baseHeight: number, options?: PrimarySpriteMesh.ResizeOptions): void;
-
-    protected override _updateBatchData(): void;
-
-    protected override _calculateCanvasBounds(): void;
-
-    /**
-     * Is the given point in canvas space contained in this object?
-     * @param point                 - The point in canvas space
-     * @param textureAlphaThreshold - The minimum texture alpha required for containment
-     */
-    containsCanvasPoint(
-      point: PIXI.IPointData,
-      /** @defaultValue `this.textureAlphaThreshold` */
-      textureAlphaThreshold?: number,
-    ): boolean;
-
-    /**
-     * Is the given point in world space contained in this object?
-     * @param point                 - The point in world space
-     * @param textureAlphaThreshold - The minimum texture alpha required for containment
-     */
-    containsPoint(
-      point: PIXI.IPointData,
-      /** @defaultValue `this.textureAlphaThreshold` */
-      textureAlphaThreshold?: number,
-    ): boolean;
-
-    override renderDepthData(renderer: PIXI.Renderer): void;
-
-    /**
-     * Render the sprite with ERASE blending.
-     * Note: The sprite must not have visible/renderable children.
-     * @param renderer - The renderer
-     */
-    protected _renderVoid(renderer: PIXI.Renderer): void;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "#getPixelAlpha is deprecated without replacement."
-     */
-    getPixelAlpha(x: number, y: number): number;
-
-    /**
-     * @deprecated since v12, until v14
-     * @remarks "#_getAlphaBounds is deprecated without replacement."
-     */
-    _getAlphaBounds(): PIXI.Rectangle;
-
-    /**
-     * @deprecated since v12, until v14
-     * @remarks "#_getTextureCoordinate is deprecated without replacement."
-     */
-    _getTextureCoordinate(testX: number, testY: number): PIXI.IPointData;
-  }
-
-  namespace PrimarySpriteMesh {
-    interface Any extends AnyPrimarySpriteMesh {}
-    type AnyConstructor = typeof AnyPrimarySpriteMesh;
-
-    type FitType = "fill" | "cover" | "contain" | "width" | "height";
-
-    /** @internal */
-    type _ConstructorOptions = NullishProps<{
-      /**
-       * Texture passed to the SpriteMesh.
-       * @defaultValue `null`
-       * @remarks Default ultimately provided by the `SpriteMesh` constructor
-       */
-      texture: PIXI.Texture;
-
-      /**
-       * The shader class used to render this sprite.
-       * @defaultValue `PrimaryBaseSamplerShader`
-       * @remarks Default provided by `??=` in function body
-       */
-      shaderClass: PrimaryBaseSamplerShader.AnyConstructor;
-
-      /**
-       * The name of this sprite.
-       * @defaultValue `null`
-       * @remarks Default provided by `?? null` in function body
-       */
-      name: string;
-
-      /**
-       * Any object that owns this PCO.
-       * @defaultValue `null`
-       * @remarks Default via `?? null` in function body
-       * @privateRemarks Foundry types as `*`, but the only things passed in practice are `Tile`s, `Token`s, and the `PrimaryCanvasGroup`
-       */
-      //TODO: (esheyw) Revisit the "any canvas group" type when groups are done
-      object: PlaceableObject.Any | CanvasGroupMixin.AnyMixed;
-    }>;
-
-    /** The constructor options */
-    interface ConstructorOptions extends _ConstructorOptions {}
-
-    /** @internal */
-    type _ResizeOptions = InexactPartial<{
-      /**
-       * The fit type.
-       * @defaultValue `"fill"`
-       * @remarks Can't be `null` because it only has a parameter default, and is then fed into a switch statement where the default is throw
-       * */
-      fit: FitType;
-
-      /**
-       * The scale on X axis.
-       * @defaultValue `1`
-       * @remarks Can't be `null` because it only has a parameter default and a width scale of 0 is, if not nonsensical, not to be done by accident.
-       */
-      scaleX: number;
-
-      /**
-       * The scale on Y axis.
-       * @defaultValue `1`
-       * @remarks Can't be `null` because it only has a parameter default and a height scale of 0 is, if not nonsensical, not to be done by accident.
-       */
-      scaleY: number;
-    }>;
-
-    interface ResizeOptions extends _ResizeOptions {}
-  }
-}
-
-declare abstract class AnyPrimarySpriteMesh extends PrimarySpriteMesh {
-  constructor(arg0: never, ...args: never[]);
-}