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

package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts

@@ -1,299 +0,0 @@
-import type { HandleEmptyObject, Identity, InexactPartial, IntentionalPartial, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A CanvasLayer for displaying visual effects like weather, transitions, flashes, or more
-   */
-  class WeatherEffects extends FullCanvasObjectMixin(CanvasLayer) {
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior, due to `layerOptions.name` being `"effects"`
-     */
-    static get instance(): Canvas["effects"];
-
-    /**
-     * @defaultValue `true`
-     */
-    override sortableChildren: boolean;
-
-    /**
-     * @defaultValue `"none"`
-     */
-    override eventMode: PIXI.EventMode;
-
-    /**
-     * The container in which effects are added.
-     * @remarks Only `undefined` prior to first draw
-     */
-    weatherEffects: PIXI.Container | undefined;
-
-    /**
-     * The container in which suppression meshed are added.
-     * @remarks Only `undefined` prior to first draw
-     */
-    suppression: PIXI.Container | undefined;
-
-    /**
-     * @defaultValue `foundry.utils.mergeObject(super.layerOptions, { name: "effects" })`
-     */
-    static override get layerOptions(): WeatherEffects.LayerOptions;
-
-    /** @privateRemarks Types-only override to sync with static `layerOptions` */
-    override options: WeatherEffects.LayerOptions;
-
-    /**
-     * Array of weather effects linked to this weather container.
-     */
-    effects: Map<string, Array<ParticleEffect | WeatherShaderEffect>>;
-
-    /**
-     * A default configuration of the terrain mask that is automatically applied to any shader-based weather effects.
-     * This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.
-     *
-     * @privateRemarks In practice this is always `undefined`, as it is not initialized to a value and never gets set anywhere in core in v12.331
-     */
-    terrainMaskConfig: WeatherEffects.MaskConfiguration | undefined;
-
-    /**
-     * A default configuration of the terrain mask that is automatically applied to any shader-based weather effects.
-     * This configuration is automatically passed to WeatherShaderEffect#configureTerrainMask upon construction.
-     *
-     * @privateRemarks In practice this is always `undefined`, as it is not initalized to a value and never gets set anywhere in core in v12.331.
-     * Passed as `this.occlusionMaskConfig || { enabled: true }` where it is used.
-     */
-    occlusionMaskConfig: WeatherEffects.MaskConfiguration | undefined;
-
-    /**
-     * The inverse occlusion mask filter bound to this container.
-     */
-    occlusionFilter: WeatherOcclusionMaskFilter;
-
-    /**
-     * The elevation of this object.
-     * @defaultValue `Infinity`
-     * @throws If `NaN` is passed to the setter
-     */
-    get elevation(): number;
-
-    set elevation(value);
-
-    /**
-     * A key which resolves ties amongst objects at the same elevation of different layers.
-     * @defaultValue `PrimaryCanvasGroup.SORT_LAYERS.WEATHER`
-     * @throws If `NaN` is passed to the setter
-     */
-    get sortLayer(): number;
-
-    set sortLayer(value);
-
-    /**
-     * A key which resolves ties amongst objects at the same elevation within the same layer.
-     * @defaultValue `0`
-     * @throws If `NaN` is passed to the setter
-     */
-    get sort(): number;
-
-    set sort(value);
-
-    /**
-     * A key which resolves ties amongst objects at the same elevation within the same layer and same sort.
-     * @throws If `NaN` is passed to the setter
-     */
-    get zIndex(): number;
-
-    set zIndex(value);
-
-    protected override _draw(options: HandleEmptyObject<WeatherEffects.DrawOptions>): Promise<void>;
-
-    protected override _tearDown(options: HandleEmptyObject<WeatherEffects.TearDownOptions>): Promise<void>;
-
-    /**
-     * Initialize the weather container from a weather config object.
-     * @param weatherEffectsConfig - Weather config object (or null/undefined to clear the container).
-     */
-    initializeEffects(weatherEffectsConfig?: WeatherEffects.AmbienceConfiguration | null): void;
-
-    /**
-     * Clear the weather container.
-     * @remarks Just calls `initializeEffects(null)`
-     */
-    clearEffects(): void;
-
-    /**
-     * Set the occlusion uniforms for this weather shader.
-     * @param context - The shader context
-     * @param config  - Occlusion masking options
-     */
-    static configureOcclusionMask(
-      context: PIXI.Shader,
-      config?: WeatherEffects.MaskConfiguration, // not:null (destructured)
-    ): void;
-
-    /**
-     * Set the terrain uniforms for this weather shader.
-     * @param context - The shader context
-     * @param config  - Terrain masking options
-     */
-    static configureTerrainMask(
-      context: PIXI.Shader,
-      config?: WeatherEffects.MaskConfiguration, // not:null (destructured)
-    ): void;
-
-    /**
-     * @deprecated since v11, will be removed in v13
-     * @remarks `"The WeatherContainer at canvas.weather.weather is deprecated and combined with the layer itself."`
-     */
-    get weather(): this;
-  }
-
-  namespace WeatherEffects {
-    interface Any extends AnyWeatherEffects {}
-    interface AnyConstructor extends Identity<typeof AnyWeatherEffects> {}
-
-    interface LayerOptions extends CanvasLayer.LayerOptions {
-      /** @remarks This causes `WeatherEffect.instance` to be the `EffectsCanvasGroup` */
-      name: "effects";
-    }
-
-    interface DrawOptions extends CanvasLayer.DrawOptions {}
-
-    interface TearDownOptions extends CanvasLayer.TearDownOptions {}
-
-    /**
-     * @internal
-     * @privateRemarks If `WeatherEffects#occlusionMaskConfig` or `#terrainMaskConfig` were *ever* set, i.e
-     * if this interface was ever used for more than a parameter type, it would have a base interface with
-     * no optionality/nullishness applied. Luckily it's not.
-     */
-    type _MaskConfiguration = NullishProps<{
-      /**
-       * Enable or disable this mask.
-       * @defaultValue `false`
-       */
-      enabled: boolean;
-
-      /**
-       * If the mask should be reversed.
-       * @defaultValue `false`
-       */
-      reverse: boolean;
-    }> &
-      InexactPartial<{
-        /**
-         * An RGBA array of channel weights applied to the mask texture.
-         * @defaultValue `[0, 0, 1, 0]`
-         * @remarks Can't be `null` as it only has a parameter default.
-         */
-        channelWeights: [r: number, b: number, g: number, a: number];
-
-        /**
-         * A texture which defines the mask region.
-         * @remarks Can't be `null` because of an `!== undefined` check.
-         *
-         * If not provided, the shader being modified will have its `uniforms.useTerrain` or `.useOcclusion` set `false`
-         */
-        texture: PIXI.Texture | PIXI.RenderTexture;
-      }>;
-
-    interface MaskConfiguration extends _MaskConfiguration {}
-
-    type AmbienceFilterConfiguration = IntentionalPartial<{
-      /**
-       * Enable a layer-wide occlusion filter unless it is explicitly disabled by the effect configuration
-       * @remarks The above should for clarity say `ambience configuration` instead of `effect configuration`;
-       * Individual effects of this ambience can enable occlusion on themselves if this is set false, but
-       * cannot disable layer-wide occlusion if this is `true`
-       *
-       * @privateRemarks Checked for `!== false`, so allowing nullish values that get handled as `true` would be confusing
-       */
-      enabled: boolean;
-    }> &
-      NullishProps<{
-        /**
-         * @defaultValue `PIXI.BLEND_MODES.NORMAL`
-         * @remarks The blend mode applied to the `WeatherEffects#occlusionFilter`
-         */
-        blendMode: PIXI.BLEND_MODES;
-      }>;
-
-    /** @internal */
-    type _CommonEffectConfiguration = NullishProps<{
-      /**
-       * @defaultValue `CONST.CANVAS_PERFORMANCE_MODES.LOW`
-       * @remarks The minimum required performance level to render this effect
-       */
-      performanceLevel: CONST.CANVAS_PERFORMANCE_MODES;
-
-      /**
-       * @defaultValue The index of this effect in its array
-       * @remarks Applied to the constructed `effectClass`. None of the effects in core ambience definitions provide one.
-       */
-      zIndex: number;
-
-      /**
-       * @defaultValue `PIXI.BLEND_MODES.NORMAL`
-       * @remarks Applied to the constructed `effectClass`
-       */
-      blendMode: PIXI.BLEND_MODES;
-    }>;
-
-    interface ParticleEffectConfiguration extends _CommonEffectConfiguration {
-      id: string;
-
-      effectClass: ParticleEffect.AnyConstructor;
-
-      /**
-       * @remarks Despite the corresponding `ParticleEffect#constructor` parameter being `={}`, construction will
-       * throw if this isn't a non-empty object, **except** in the case of the only core `extends ParticleEffect`
-       * class, {@link AutumnLeavesWeatherEffect | `AutumnLeavesWeatherEffect`}, which overrides the relevant method and always uses its static
-       * `LEAF_CONFIG` property instead; accounting for this is the only reason the property is optional
-       */
-      config: PIXI.particles.EmitterConfigV3;
-    }
-
-    interface SpecificallyAutumnLeavesConfiguration {
-      id: string;
-
-      effectClass: AutumnLeavesWeatherEffect.AnyConstructor;
-
-      /** @remarks {@link AutumnLeavesWeatherEffect | `AutumnLeavesWeatherEffect`} overrides {@link ParticleEffect.getParticleEmitters | `ParticleEffect#getParticleEmitters`} -- the method that would throw when passed an empty config -- to not take any parameters and always use */
-      config?: never;
-    }
-
-    interface WeatherShaderEffectConfiguration extends _CommonEffectConfiguration {
-      id: string;
-
-      effectClass: WeatherShaderEffect.AnyConstructor;
-
-      shaderClass: AbstractWeatherShader.AnyConstructor;
-
-      /** @remarks Can't be `null` because it gets `Object.entries()`ed with only a parameter default */
-      config?: WeatherShaderEffect.Configuration | undefined;
-    }
-
-    type EffectConfiguration =
-      | SpecificallyAutumnLeavesConfiguration
-      | ParticleEffectConfiguration
-      | WeatherShaderEffectConfiguration;
-
-    /** @internal */
-    type _AmbienceConfiguration = NullishProps<{
-      /** @remarks Properties of `filter` are always accessed with optional chaining in v12.331  */
-      filter: AmbienceFilterConfiguration;
-    }>;
-
-    interface AmbienceConfiguration extends _AmbienceConfiguration {
-      /** @remarks Should match the key for this ambience in the parent object (`CONFIG.Canvas.weatherEffects`) */
-      id: string;
-
-      /** @remarks A localization key to display in the Configure Scene sheet */
-      label: string;
-
-      /** @remarks One or more effect definitions */
-      effects: EffectConfiguration[];
-    }
-  }
-}
-
-declare abstract class AnyWeatherEffects extends WeatherEffects {
-  constructor(...args: never);
-}

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

@@ -1,43 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A special Graphics class which handles Grid layer highlighting
-   */
-  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<GridHighlight.PositionString>;
-
-    /**
-     * 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(options?: PIXI.IDestroyOptions | boolean): void;
-  }
-
-  namespace GridHighlight {
-    interface Any extends AnyGridHightlight {}
-    interface AnyConstructor extends Identity<typeof AnyGridHightlight> {}
-
-    type PositionString = `${number},${number}`;
-  }
-}
-
-declare abstract class AnyGridHightlight extends GridHighlight {
-  constructor(...args: never);
-}

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

@@ -1,3 +0,0 @@
-import "./highlight.d.mts";
-import "./layer.d.mts";
-import "./mesh.d.mts";

package/src/foundry/client/pixi/layers/grid/layer.d.mts

@@ -1,269 +0,0 @@
-import type { EmptyObject, HandleEmptyObject, Identity, NullishProps, RemoveIndexSignatures } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A CanvasLayer responsible for drawing a square grid
-   */
-  class GridLayer extends CanvasLayer {
-    /**
-     * @remarks Due to the grid rework in v12 this points to a BaseGrid subclass rather than a GridLayer instance,
-     *          however to avoid inheritance-based issues this is left as the intended GridLayer instance
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): GridLayer;
-
-    /**
-     * The grid mesh.
-     * @defaultValue `undefined`
-     * @remarks Only `undefined` prior to first draw
-     */
-    mesh: GridMesh | undefined;
-
-    /**
-     * The Grid Highlight container
-     * @defaultValue `undefined`
-     * @remarks Only `undefined` prior to first draw
-     */
-    highlight: PIXI.Container | undefined;
-
-    /**
-     * Map named highlight layers
-     * @defaultValue `{}`
-     */
-    highlightLayers: Record<string, GridHighlight>;
-
-    /**
-     * @defaultValue
-     * ```js
-     * foundry.utils.mergeObject(super.layerOptions, {name: "grid"});
-     * ```
-     */
-    static override get layerOptions(): GridLayer.LayerOptions;
-
-    override options: GridLayer.LayerOptions;
-
-    protected override _draw(options: HandleEmptyObject<GridLayer.DrawOptions>): Promise<void>;
-
-    /**
-     * Creates the grid mesh.
-     */
-    protected _drawMesh(): GridMesh;
-
-    /**
-     * Initialize the grid mesh appearance and configure the grid shader.
-     * @remarks All the properties of `options` are optional, but it lacks an `={}` default so an object must be passed, even if empty
-     */
-    initializeMesh(options: GridLayer.InitializeMeshOptions): void;
-
-    /**
-     * 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
-     * @remarks Despite being an `={}` parameter, `options` is required, as not providing `x` or `y` produces `NaN`s
-     * or puts garbage data into the associated `GridHightlightLayer`, depending on the current grid type
-     */
-    highlightPosition(name: string, options: GridLayer.HighlightPositionOptions): void;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#type is deprecated. Use canvas.grid.type instead."
-     */
-    get type(): foundry.CONST.GRID_TYPES;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#size is deprecated. Use canvas.grid.size instead.
-     */
-    get size(): number;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#grid is deprecated. Use canvas.grid instead."
-     */
-    get grid(): Canvas["grid"];
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#isNeighbor is deprecated. Use canvas.grid.testAdjacency instead."
-     */
-    isNeighbor(r0: number, c0: number, r1: number, c1: number): boolean;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#w is deprecated in favor of canvas.grid.sizeX."
-     */
-    get w(): number;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#h is deprecated in favor of canvas.grid.sizeY."
-     */
-    get h(): number;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#isHex is deprecated. Use canvas.grid.isHexagonal instead."
-     */
-    get isHex(): boolean;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#getTopLeft is deprecated. Use canvas.grid.getTopLeftPoint instead."
-     */
-    getTopLeft(x: number, y: number): Canvas.PointTuple;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#getCenter is deprecated. Use canvas.grid.getCenterPoint instead."
-     */
-    getCenter(x: number, y: number): Canvas.PointTuple;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks "GridLayer#getSnappedPosition is deprecated. Use canvas.grid.getCenterPoint instead."
-     */
-    getSnappedPosition(
-      x: number,
-      y: number,
-      /**
-       * @defaultValue `1`
-       * @remarks Can't be `null` due to being used directly as a divisor
-       */
-      interval?: number,
-      /** @remarks Unused */
-      options?: EmptyObject | null,
-    ): PIXI.IPointData;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#measureDistance is deprecated. "Use canvas.grid.measurePath instead for non-Euclidean measurements."`
-     */
-    measureDistance(
-      origin: Canvas.Point,
-      target: Canvas.Point,
-      /** @remarks Unused */
-      options?: EmptyObject | null,
-    ): number;
-  }
-
-  namespace GridLayer {
-    interface Any extends AnyGridLayer {}
-    interface AnyConstructor extends Identity<typeof AnyGridLayer> {}
-
-    interface DrawOptions extends CanvasLayer.DrawOptions {}
-
-    interface TearDownOptions extends CanvasLayer.TearDownOptions {}
-
-    interface LayerOptions extends CanvasLayer.LayerOptions {
-      name: "grid";
-    }
-
-    /** @internal */
-    type _InitializeMeshOptions = NullishProps<{
-      /** The grid style */
-      style: ConfiguredGridStyles;
-    }>;
-
-    interface InitializeMeshOptions
-      extends _InitializeMeshOptions,
-        Pick<GridMesh.InitializationMeshData, "thickness" | "color" | "alpha"> {}
-
-    /** @internal */
-    type _HighlightPositionOptions = NullishProps<{
-      /**
-       * @defaultValue `0x33BBFF`
-       * @remarks This value eventually ends up at `PIXI.Graphics#normalizeColor()`, which handles `null` as `0` (black)
-       */
-      color: PIXI.ColorSource | Color;
-
-      /**
-       * The border color of the highlight
-       * @defaultValue `null`
-       * @remarks If `null`, no border will be drawn.
-       */
-      border: PIXI.ColorSource | Color;
-
-      /**
-       * The opacity of the highlight
-       * @defaultValue `0.25`
-       * @remarks The above is only a parameter default; `PIXI.Graphics#normalizeColor()` will replace `null` with `1`
-       */
-      alpha: number;
-
-      /**
-       * A predefined shape to highlight
-       * @defaultValue `null`
-       * @remarks Must be provided on gridless scenes or highlighting will fail quietly
-       */
-      shape: PIXI.IShape;
-    }>;
-
-    interface HighlightPositionOptions extends _HighlightPositionOptions {
-      /**
-       * The x-coordinate of the highlighted position
-       * @remarks Required despite Foundry marking it optional. If omitted on gridless will produce `NaN`s,
-       * and on other grid types will insert garbage data into the associated `GridHighlightLayer`
-       */
-      x: number;
-
-      /**
-       * The y-coordinate of the highlighted position
-       * @remarks Required despite Foundry marking it optional. If omitted on gridless will produce `NaN`s,
-       * and on other grid types will insert garbage data into the associated `GridHighlightLayer`
-       */
-      y: number;
-    }
-
-    /** @internal */
-    type _GridStyle = NullishProps<{
-      /** @defaultValue `GridShader` */
-      shaderClass: GridShader.AnyConstructor;
-
-      /** @defaultValue `{}` */
-      shaderOptions: NullishProps<{
-        /**
-         * @defaultValue `0`
-         * @remarks Gets applied to the constructed shaderClass instance's `uniforms`.
-         *
-         * @privateRemarks It's unclear if this is actually repesenting an enum value or not, so it's been left as `number`.
-         */
-        style: number;
-      }>;
-    }>;
-
-    interface GridStyle extends _GridStyle {
-      /** @remarks A localization key to display in the Configure Scene sheet */
-      label: string;
-    }
-
-    type ConfiguredGridStyles = keyof RemoveIndexSignatures<CONFIG["Canvas"]["gridStyles"]>;
-  }
-}
-
-declare abstract class AnyGridLayer extends GridLayer {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/layers/grid/mesh.d.mts

@@ -1,94 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The grid mesh, which uses the {@link GridShader | `GridShader`} to render the grid.
-   */
-  class GridMesh extends QuadMesh {
-    /**
-     * The grid mesh constructor.
-     * @param shaderClass - The shader class
-     */
-    constructor(shaderClass: GridShader.AnyConstructor);
-
-    /**
-     * The data of this mesh.
-     * @defaultValue
-     * ```js
-     * {
-     *   type: CONST.GRID_TYPES.GRIDLESS,
-     *   width: 0,
-     *   height: 0,
-     *   size: 0,
-     *   thickness: 1,
-     *   color: 0,
-     *   alpha: 1
-     * }
-     * ```
-     */
-    data: GridMesh.MeshData;
-
-    /**
-     * Initialize and update the mesh given the (partial) data.
-     * @param data - The (partial) data
-     */
-    initialize(data: GridMesh.InitializationMeshData): this;
-
-    /**
-     * Initialize the data of this mesh given the (partial) data.
-     * @param data - The (partial) data.
-     */
-    protected _initialize(data: GridMesh.InitializationMeshData): void;
-  }
-
-  namespace GridMesh {
-    /**
-     * The grid mesh data.
-     */
-    interface MeshData {
-      /**
-       * The type of the grid (see {@link CONST.GRID_TYPES | `CONST.GRID_TYPES`})
-       * @defaultValue `CONST.GRID_TYPES.GRIDLESS`
-       */
-      type: foundry.CONST.GRID_TYPES;
-
-      /**
-       * The width of the grid in pixels
-       * @defaultValue `0`
-       */
-      width: number;
-
-      /**
-       * The height of the grid in pixels
-       * @defaultValue `0`
-       */
-      height: number;
-
-      /**
-       * The size of a grid space in pixels
-       * @defaultValue `0`
-       */
-      size: number;
-
-      /**
-       * The thickness of the grid lines in pixels
-       * @defaultValue `1`
-       */
-      thickness: number;
-
-      /**
-       * The color of the grid
-       * @defaultValue `0`
-       */
-      color: number;
-
-      /**
-       * The alpha of the grid
-       * @defaultValue `1`
-       */
-      alpha: number;
-    }
-
-    interface InitializationMeshData extends InexactPartial<MeshData> {}
-  }
-}