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

package/src/foundry/client/pixi/groups/primary.d.mts

@@ -1,222 +0,0 @@
-import type { Brand, HandleEmptyObject, Identity } from "fvtt-types/utils";
-
-// Included to match Foundry's documented types
-type PrimaryCanvasObject = ReturnType<typeof PrimaryCanvasObjectMixin>;
-
-declare global {
-  /**
-   * The primary Canvas group which generally contains tangible physical objects which exist within the Scene.
-   * This group is a {@link CachedContainer | `CachedContainer`} which is rendered to the Scene as a {@link SpriteMesh | `SpriteMesh`}.
-   * This allows the rendered result of the Primary Canvas Group to be affected by a {@link BaseSamplerShader | `BaseSamplerShader`}.
-   */
-  class PrimaryCanvasGroup<
-    DrawOptions extends PrimaryCanvasGroup.DrawOptions = PrimaryCanvasGroup.DrawOptions,
-    TearDownOptions extends PrimaryCanvasGroup.TearDownOptions = PrimaryCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof CachedContainer, "primary">(CachedContainer)<DrawOptions, TearDownOptions> {
-    /**
-     * @param sprite - (default: `new SpriteMesh(undefined, BaseSamplerShader)`)
-     */
-    constructor(sprite?: SpriteMesh);
-
-    /**
-     * Sort order to break ties on the group/layer level.
-     */
-    static SORT_LAYERS: PrimaryCanvasGroup.Sort_Layers;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   scaleMode: PIXI.SCALE_MODES.NEAREST,
-     *   format: PIXI.FORMATS.RGB,
-     *   multisample: PIXI.MSAA_QUALITY.NONE
-     * }
-     * ```
-     */
-    static override textureConfiguration: CachedContainer.TextureConfiguration;
-
-    /**
-     * @defaultValue `"none"`
-     */
-    override eventMode: PIXI.EventMode;
-
-    /**
-     * @defaultValue `[0, 0, 0, 0]`
-     */
-    override clearColor: Color.RGBAColorVector;
-
-    /**
-     * The background color in RGB.
-     */
-    _backgroundColor: Color.RGBColorVector | undefined;
-
-    /**
-     * Track the set of HTMLVideoElements which are currently playing as part of this group.
-     */
-    videoMeshes: Set<SpriteMesh>;
-
-    /**
-     * Occludable objects above this elevation are faded on hover.
-     * @defaultValue `0`
-     */
-    hoverFadeElevation: number;
-
-    /**
-     * Allow API users to override the default elevation of the background layer.
-     * This is a temporary solution until more formal support for scene levels is added in a future release.
-     */
-    static BACKGROUND_ELEVATION: number;
-
-    /**
-     * The primary background image configured for the Scene, rendered as a SpriteMesh.
-     */
-    background: SpriteMesh | undefined;
-
-    /**
-     * The primary foreground image configured for the Scene, rendered as a SpriteMesh.
-     */
-    foreground: SpriteMesh | undefined;
-
-    /**
-     * A Quadtree which partitions and organizes primary canvas objects.
-     */
-    quadtree: CanvasQuadtree<PrimaryCanvasObjectMixin.AnyMixed>;
-
-    /**
-     * The collection of PrimaryDrawingContainer objects which are rendered in the Scene.
-     * @privateRemarks Foundry types this as `Collection<PrimaryDrawingContainer>`, which doesn't exist. It's `PrimaryGraphics` in practice.
-     */
-    drawings: Collection<PrimaryGraphics>;
-
-    /**
-     * The collection of SpriteMesh objects which are rendered in the Scene.
-     * @privateRemarks Foundry types this as `Collection<TokenMesh>`, which doesn't exist. In practice it's `PrimarySpriteMesh`
-     */
-    tokens: Collection<PrimarySpriteMesh>;
-
-    /**
-     * The collection of SpriteMesh objects which are rendered in the Scene.
-     * @privateRemarks Foundry types this as `Collection<PrimarySpriteMesh | TileSprite>`, but `TileSprite` doens't exist. In practice it's all `PrimarySpriteMesh`.
-     */
-    tiles: Collection<PrimarySpriteMesh>;
-
-    /**
-     * The ambience filter which is applying post-processing effects.
-     */
-    _ambienceFilter: PrimaryCanvasGroupAmbienceFilter | undefined;
-
-    /**
-     * Return the base HTML image or video element which provides the background texture.
-     * @privateRemarks Foundry does not indicate the possibility of a null return
-     */
-    get backgroundSource(): HTMLImageElement | HTMLVideoElement | null;
-
-    /**
-     * Return the base HTML image or video element which provides the foreground texture.
-     * @privateRemarks Foundry does not indicate the possibility of a null return
-     */
-    get foregroundSource(): HTMLImageElement | HTMLVideoElement | null;
-
-    /**
-     * Refresh the primary mesh.
-     */
-    refreshPrimarySpriteMesh(): void;
-
-    /**
-     * Update this group. Calculates the canvas transform and bounds of all its children and updates the quadtree.
-     */
-    update(): void;
-
-    protected override _draw(options: HandleEmptyObject<DrawOptions>): Promise<void>;
-
-    protected override _render(_renderer: PIXI.Renderer): void;
-
-    protected override _tearDown(options: HandleEmptyObject<TearDownOptions>): Promise<void>;
-
-    /**
-     * Draw the SpriteMesh for a specific Token object.
-     * @param token - The Token being added
-     * @returns The added PrimarySpriteMesh
-     */
-    addToken(token: Token.Implementation): PrimarySpriteMesh;
-
-    /**
-     * Remove a TokenMesh from the group.
-     * @param token - The Token being removed
-     */
-    removeToken(token: Token.Implementation): void;
-
-    /**
-     * Draw the SpriteMesh for a specific Token object.
-     * @param tile - The Tile being added
-     * @returns The added PrimarySpriteMesh
-     */
-    addTile(tile: Tile.Implementation): PrimarySpriteMesh;
-
-    /**
-     * Remove a TokenMesh from the group.
-     * @param tile - The Tile being removed
-     */
-    removeTile(tile: Tile.Implementation): void;
-
-    /**
-     * Add a PrimaryGraphics to the group.
-     * @param drawing - The Drawing being added
-     * @returns The created PrimaryGraphics instance
-     */
-    addDrawing(drawing: Drawing.Implementation): PrimaryGraphics;
-
-    /**
-     * Remove a PrimaryGraphics from the group.
-     * @param drawing - The Drawing being removed
-     */
-    removeDrawing(drawing: Drawing.Implementation): void;
-
-    /**
-     * Override the default PIXI.Container behavior for how objects in this container are sorted.
-     * @remarks Actually an override of `PIXI.Container#sortChildren`
-     */
-    sortChildren(): void;
-
-    /**
-     * Handle mousemove events on the primary group to update the hovered state of its children.
-     * @remarks Foundry marked `@internal`
-     */
-    _onMouseMove(): void;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks `"PrimaryCanvasGroup#mapElevationAlpha is deprecated. Use canvas.masks.depth.mapElevation(elevation) instead."`
-     */
-    mapElevationToDepth(elevation: number): number;
-
-    /**
-     * @deprecated since v11, will be removed in v13
-     * @remarks "PrimaryCanvasGroup#mapElevationAlpha is deprecated in favor of PrimaryCanvasGroup#mapElevationToDepth"
-     */
-    mapElevationAlpha(elevation: number): number;
-  }
-
-  namespace PrimaryCanvasGroup {
-    interface Any extends AnyPrimaryCanvasGroup {}
-    interface AnyConstructor extends Identity<typeof AnyPrimaryCanvasGroup> {}
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-
-    type SORT_LAYERS = Brand<number, "PrimaryCanvasGroup.SORT_LAYERS">;
-
-    interface Sort_Layers {
-      readonly SCENE: 0 & SORT_LAYERS;
-      readonly TILES: 500 & SORT_LAYERS;
-      readonly DRAWINGS: 600 & SORT_LAYERS;
-      readonly TOKENS: 700 & SORT_LAYERS;
-      readonly WEATHER: 1000 & SORT_LAYERS;
-    }
-  }
-}
-
-declare abstract class AnyPrimaryCanvasGroup extends PrimaryCanvasGroup {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/groups/rendered.d.mts

@@ -1,30 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A container group which contains the environment canvas group and the interface canvas group.
-   */
-  class RenderedCanvasGroup<
-    DrawOptions extends RenderedCanvasGroup.DrawOptions = RenderedCanvasGroup.DrawOptions,
-    TearDownOptions extends RenderedCanvasGroup.TearDownOptions = RenderedCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof PIXI.Container, "rendered">(PIXI.Container)<DrawOptions, TearDownOptions> {
-    /**
-     * Should this group tear down its non-layer children?
-     * @defaultValue `false`
-     */
-    static override tearDownChildren: boolean;
-  }
-
-  namespace RenderedCanvasGroup {
-    interface Any extends AnyRenderedCanvasGroup {}
-    interface AnyConstructor extends Identity<typeof AnyRenderedCanvasGroup> {}
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyRenderedCanvasGroup extends RenderedCanvasGroup {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/index.d.mts

@@ -1,10 +0,0 @@
-import "./board.d.mts";
-import "./core/index.d.mts";
-import "./extensions/index.d.mts";
-import "./groups/index.d.mts";
-import "./layers/index.d.mts";
-import "./perception/index.d.mts";
-import "./placeable.d.mts";
-import "./placeables/index.d.mts";
-import "./webgl/index.d.mts";
-import "./workers/index.d.mts";

package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts

@@ -1,91 +0,0 @@
-import type { HandleEmptyObject, Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An abstract pattern for primary layers of the game canvas to implement
-   */
-  abstract class CanvasLayer extends PIXI.Container {
-    /**
-     * Options for this layer instance.
-     * @defaultValue `this.constructor.layerOptions`
-     */
-    options: CanvasLayer.LayerOptions;
-
-    /**
-     * @defaultValue `false`
-     */
-    override interactiveChildren: boolean;
-
-    /**
-     * Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.
-     */
-    static get layerOptions(): CanvasLayer.LayerOptions;
-
-    /**
-     * Return a reference to the active instance of this canvas layer
-     */
-    static get instance(): CanvasLayer.Any | PIXI.Container | undefined;
-
-    /**
-     * The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.
-     * @remarks Foundry defines this as a getter, but since CanvasLayer extends PIXI.Container, it has to be a property.
-     */
-    readonly name: string;
-
-    /**
-     * The name used by hooks to construct their hook string.
-     * Note: You should override this getter if hookName should not return the class constructor name.
-     */
-    get hookName(): string;
-
-    /**
-     * Draw the canvas layer, rendering its internal components and returning a Promise
-     * The Promise resolves to the drawn layer once its contents are successfully rendered.
-     * @param options - Options which configure how the layer is drawn
-     */
-    draw(options?: HandleEmptyObject<CanvasLayer.DrawOptions>): Promise<this>;
-
-    /**
-     * The inner _draw method which must be defined by each CanvasLayer subclass.
-     * @param options - Options which configure how the layer is drawn
-     */
-    protected abstract _draw(options: HandleEmptyObject<CanvasLayer.DrawOptions>): Promise<void>;
-
-    /**
-     * Deconstruct data used in the current layer in preparation to re-draw the canvas
-     * @param options - Options which configure how the layer is deconstructed
-     * @remarks ControlsLayer returns void. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6939
-     */
-    tearDown(options?: HandleEmptyObject<CanvasLayer.TearDownOptions>): Promise<this>;
-
-    /**
-     * The inner _tearDown method which may be customized by each CanvasLayer subclass.
-     * @param options - Options which configure how the layer is deconstructed
-     */
-    protected _tearDown(options: HandleEmptyObject<CanvasLayer.TearDownOptions>): Promise<void>;
-  }
-
-  namespace CanvasLayer {
-    interface Any extends AnyCanvasLayer {}
-    interface AnyConstructor extends Identity<typeof AnyCanvasLayer> {}
-
-    interface LayerOptions {
-      /**
-       * The layer name by which the instance is referenced within the Canvas
-       */
-      name: string;
-
-      baseClass: typeof CanvasLayer;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-    interface DrawOptions {}
-
-    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-    interface TearDownOptions {}
-  }
-}
-
-declare abstract class AnyCanvasLayer extends CanvasLayer {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/layers/base/index.d.mts

@@ -1,3 +0,0 @@
-import "./canvas-layer.d.mts";
-import "./interaction-layer.d.mts";
-import "./placeables-layer.d.mts";

package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts

@@ -1,163 +0,0 @@
-import type { HandleEmptyObject, Identity, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A subclass of CanvasLayer which provides support for user interaction with its contained objects.
-   */
-  class InteractionLayer extends CanvasLayer {
-    /**
-     * Is this layer currently active
-     */
-    get active(): boolean;
-
-    /**
-     * @privateRemarks Override not in foundry docs but implicit from layerOptions
-     */
-    override options: InteractionLayer.LayerOptions;
-
-    /**
-     * @defaultValue `"passive"`
-     * @remarks Set to `"static"` when this layer is `#activate()`d, returned to `"passive"` when `#deactivate()`d
-     */
-    override eventMode: PIXI.EventMode;
-
-    /**
-     * Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.
-     * @defaultValue
-     * ```js
-     * {
-     *   baseClass: InteractionLayer,
-     *   zIndex: 0,
-     * }
-     * ```
-     */
-    static get layerOptions(): InteractionLayer.LayerOptions;
-
-    /**
-     * Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.
-     * @param options - Options which configure layer activation
-     * @returns - The layer instance, now activated
-     */
-    activate(options?: InteractionLayer.ActivateOptions): this;
-
-    /**
-     * The inner _activate method which may be defined by each InteractionLayer subclass.
-     */
-    protected _activate(): void;
-
-    /**
-     * Deactivate the InteractionLayer, removing interactivity from its children.
-     * @returns - The layer instance, now inactive
-     */
-    deactivate(): this;
-
-    /**
-     * The inner _deactivate method which may be defined by each InteractionLayer subclass.
-     */
-    protected _deactivate(): void;
-
-    protected override _draw(options: HandleEmptyObject<InteractionLayer.DrawOptions>): Promise<void>;
-
-    /**
-     * Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container.
-     */
-    getZIndex(): number;
-
-    /**
-     * Handle left mouse-click events which originate from the Canvas stage.
-     * @see {@link Canvas._onClickLeft | `Canvas#_onClickLeft`}
-     * @param event - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onClickLeft(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Handle double left-click events which originate from the Canvas stage.
-     * @see {@link Canvas.#onClickLeft2 | `Canvas.#onClickLeft2`}
-     * @param event - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onClickLeft2(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Does the User have permission to left-click drag on the Canvas?
-     * @param user  - The User performing the action.
-     * @param event - The event object.
-     */
-    protected _canDragLeftStart(user: User.Implementation, event: PIXI.FederatedEvent): boolean;
-
-    /**
-     * Start a left-click drag workflow originating from the Canvas stage.
-     * @see {@link Canvas.#onDragLeftStart | `Canvas.#onDragLeftStart`}
-     * @param event - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onDragLeftStart(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Continue a left-click drag workflow originating from the Canvas stage.
-     * @see {@link Canvas.#onDragLeftMove | `Canvas.#onDragLeftMove`}
-     * @param event - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onDragLeftMove(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Conclude a left-click drag workflow originating from the Canvas stage.
-     * @see {@link Canvas.#onDragLeftDrop | `Canvas.#onDragLeftDrop`}
-     * @param vent - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onDragLeftDrop(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Cancel a left-click drag workflow originating from the Canvas stage.
-     * @see {@link Canvas.#onDragLeftDrop | `Canvas.#onDragLeftDrop`}
-     * @param event - A right-click pointer event on the document.
-     */
-    protected _onDragLeftCancel(event: PointerEvent): void;
-
-    /**
-     * Handle right mouse-click events which originate from the Canvas stage.
-     * @see {@link Canvas._onClickRight | `Canvas._onClickRight`}
-     * @param event - The PIXI InteractionEvent which wraps a PointerEvent
-     */
-    protected _onClickRight(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Handle mouse-wheel events which occur for this active layer.
-     * @see {@link MouseManager._onWheel | `MouseManager._onWheel`}
-     * @param event - The WheelEvent initiated on the document
-     */
-    protected _onMouseWheel(event: WheelEvent): void;
-
-    /**
-     * Handle a DELETE keypress while this layer is active.
-     * @see {@link ClientKeybindings._onDelete | `ClientKeybindings._onDelete`}
-     * @param event - The delete key press event
-     */
-    protected _onDeleteKey(event: KeyboardEvent): Promise<void>;
-  }
-
-  namespace InteractionLayer {
-    interface Any extends AnyInteractionLayer {}
-    interface AnyConstructor extends Identity<typeof AnyInteractionLayer> {}
-
-    interface LayerOptions extends CanvasLayer.LayerOptions {
-      zIndex: number;
-
-      baseClass: typeof InteractionLayer;
-    }
-
-    /** @internal */
-    type _ActivateOptions = NullishProps<{
-      /** A specific tool in the control palette to set as active */
-      tool: string;
-    }>;
-
-    interface ActivateOptions extends _ActivateOptions {}
-
-    interface DrawOptions extends CanvasLayer.DrawOptions {}
-
-    interface TearDownOptions extends CanvasLayer.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyInteractionLayer extends InteractionLayer {
-  constructor(...args: never);
-}