@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/pixi/layers/effects/visibility.d.mts

@@ -1,19 +1,21 @@
-import type { EmptyObject, HandleEmptyObject, InexactPartial, ValueOf } from "fvtt-types/utils";
+import type { HandleEmptyObject, Identity, InexactPartial, IntentionalPartial, NullishProps } from "fvtt-types/utils";
 
 declare global {
   /**
    * The visibility Layer which implements dynamic vision, lighting, and fog of war
    * This layer uses an event-driven workflow to perform the minimal required calculation in response to changes.
-   * @see {@link PointSource}
+   * @see {@link PointSource | `PointSource`}
    */
   class CanvasVisibility extends CanvasLayer {
     /**
      * The currently revealed vision.
+     * @remarks Only `undefined` prior to first draw
      */
     vision: CanvasVisionMask.CanvasVisionContainer | undefined;
 
     /**
      * The exploration container which tracks exploration progress.
+     * @remarks Only `undefined` prior to first draw
      */
     explored: PIXI.Container | undefined;
 
@@ -22,6 +24,9 @@ declare global {
      */
     visibilityOverlay: PIXI.Sprite | undefined;
 
+    /** @remarks Doesn't exist until it's set on draw */
+    filter?: VisibilityFilter.ConfiguredInstance;
+
     /**
      * The active vision source data object
      * @defaultValue
@@ -32,10 +37,7 @@ declare global {
      * }
      * ```
      */
-    visionModeData: {
-      source: foundry.canvas.sources.PointVisionSource.Any | null | undefined;
-      activeLightingOptions: VisionMode["_source"]["lighting"] | EmptyObject;
-    };
+    visionModeData: CanvasVisibility.VisionModeData;
 
     /**
      * Define whether each lighting layer is enabled, required, or disabled by this vision mode.
@@ -50,13 +52,7 @@ declare global {
      * }
      * ```
      */
-    lightingVisibility: {
-      illumination: CanvasVisibility.LightingVisibility;
-      background: CanvasVisibility.LightingVisibility;
-      coloration: CanvasVisibility.LightingVisibility;
-      darkness: CanvasVisibility.LightingVisibility;
-      any: boolean;
-    };
+    lightingVisibility: CanvasVisibility.LightingVisibility;
 
     /**
      * A status flag for whether the layer initialization workflow has succeeded.
@@ -65,28 +61,32 @@ declare global {
 
     /**
      * Indicates whether containment filtering is required when rendering vision into a texture
+     * @remarks Foundry marked `@internal`
      */
-    protected get needsContainment(): boolean;
+    get needsContainment(): boolean;
 
     /**
      * Does the currently viewed Scene support Token field of vision?
      */
-    // TODO: make `Scene.Implementation["tokenVision"]` when docs v2 is done
-    get tokenVision(): boolean;
+    get tokenVision(): Scene.Implementation["tokenVision"];
 
     /**
      * The configured options used for the saved fog-of-war texture.
+     * @remarks Only `undefined` before first `#draw()`
      */
-    get textureConfiguration(): VisibilityTextureConfiguration | undefined;
+    get textureConfiguration(): CanvasVisibility.TextureConfiguration | undefined;
 
     /**
      * Optional overrides for exploration sprite dimensions.
      *
-     * @privateRemarks Foundry types this parameter as `FogTextureConfiguration`, and
-     * unlike the other place they used this type seeming in error, only `rect`'s
-     * `x, y, width, height` properties are accessed, so I'm assuming they meant Rectangle
+     * @privateRemarks Foundry types this parameter as `FogTextureConfiguration` in v12.331 which is plainly wrong even if it didn't not exist
+     * v13.335 types as `PIXI.Rectangle | undefined`, but only x/y/width/height are ever accessed, and only then if this has been set to something
+     * other than `undefined`, and in fact nothing in core ever does.
      */
-    set explorationRect(rect: Canvas.Rectangle);
+    set explorationRect(rect: Canvas.Rectangle | undefined);
+
+    /** @remarks This getter doesn't actually exist, it's only here to correct the type inferred from the setter */
+    get explorationRect(): undefined;
 
     /**
      * Initialize all Token vision sources which are present on this layer
@@ -132,48 +132,19 @@ declare global {
      */
     testVisibility(
       point: Canvas.Point,
-      /**
-       * @remarks Can't be NullishProps because `tolerance` gets passed directly to `_createVisibilityTestConfig`,
-       * where a default is provided only for `undefined` with `{ tolerance=2 }`, which must be numeric
-       * */
-      options?: InexactPartial<{
-        /**
-         * A numeric radial offset which allows for a non-exact match.
-         * For example, if tolerance is 2 then the test will pass if the point
-         * is within 2px of a vision polygon.
-         */
-        tolerance: number;
-
-        /**
-         * An optional reference to the object whose visibility is being tested
-         */
-        object: PlaceableObject | null;
-      }>,
+      options?: CanvasVisibility.TestVisibilityOptions, // not:null (destructured when passed to _createVisibilityTestConfig)
     ): boolean;
 
     /**
      * Create the visibility test config.
      * @param point   - The point in space to test, an object with coordinates x and y.
      * @param options - Additional options which modify visibility testing.
+     * @remarks Foundry marked `@internal`
      */
-    _createVisibilityTestConfig(
+    protected _createVisibilityTestConfig(
       point: Canvas.Point,
-      /** @remarks Can't be NullishProps because a default for `tolerance` is provided only for `undefined` with `{ tolerance=2 }`, which must be numeric */
-      options?: InexactPartial<{
-        /**
-         * A numeric radial offset which allows for a non-exact match.
-         * For example, if tolerance is 2 then the test will pass if the point
-         * is within 2px of a vision polygon
-         * @defaultValue `2`
-         */
-        tolerance: number;
-
-        /**
-         * An optional reference to the object whose visibility is being tested
-         */
-        object: PlaceableObject | null;
-      }>,
-    ): CanvasVisibilityTestConfig;
+      options?: CanvasVisibility.CreateTestConfigOptions, // not:null (destructured)
+    ): CanvasVisibility.TestConfig;
 
     /**
      * @deprecated since v11, will be removed in v13
@@ -184,45 +155,91 @@ declare global {
 
   namespace CanvasVisibility {
     interface Any extends AnyCanvasVisibility {}
-    type AnyConstructor = typeof AnyCanvasVisibility;
-
-    type LightingVisibility = ValueOf<typeof VisionMode.LIGHTING_VISIBILITY>;
+    interface AnyConstructor extends Identity<typeof AnyCanvasVisibility> {}
 
     interface DrawOptions extends CanvasLayer.DrawOptions {}
 
     interface TearDownOptions extends CanvasLayer.TearDownOptions {}
-  }
 
-  /**
-   * @privateRemarks This is name foundry has for the return tyoe of `CanvasVisibility#configureVisibilityTexture`
-   * The FogTextureConfiguration references seem to be in error
-   */
-  interface VisibilityTextureConfiguration {
-    resolution: number;
-    width: number;
-    height: number;
-    mipmap: PIXI.MIPMAP_MODES;
-    multisample: PIXI.MSAA_QUALITY;
-    scaleMode: PIXI.SCALE_MODES;
-    alphaMode: PIXI.ALPHA_MODES;
-    format: PIXI.FORMATS;
-  }
+    type TestObject = PlaceableObject.Any | null;
 
-  interface CanvasVisibilityTest {
-    point: PIXI.Point;
-    elevation: number;
-    los: Map<foundry.canvas.sources.PointVisionSource.Any, boolean>;
-  }
+    interface VisionModeData {
+      source: foundry.canvas.sources.PointVisionSource.Any | null | undefined;
+      activeLightingOptions: IntentionalPartial<VisionMode["lighting"]>;
+    }
+
+    interface LightingVisibility {
+      illumination: VisionMode.LIGHTING_VISIBILITY;
+      background: VisionMode.LIGHTING_VISIBILITY;
+      coloration: VisionMode.LIGHTING_VISIBILITY;
+      darkness: VisionMode.LIGHTING_VISIBILITY;
+      /** @remarks Only set `false` if all other keys are `VisionMode.LIGHTING_VISIBILITY.DISABLED` */
+      any: boolean;
+    }
 
-  interface CanvasVisibilityTestConfig {
-    /** The target object */
-    object: PlaceableObject | null;
+    interface TestVisibilityOptions extends CreateTestConfigOptions {}
+
+    /** @internal */
+    type _CreateTestConfigOptions = InexactPartial<{
+      /**
+       * A numeric radial offset which allows for a non-exact match.
+       * For example, if tolerance is 2 then the test will pass if the point
+       * is within 2px of a vision polygon
+       * @defaultValue `2`
+       * @remarks Can't be `null` because it only has a parameter default
+       */
+      tolerance: number;
 
-    /** An array of visibility tests */
-    tests: CanvasVisibilityTest[];
+      /**
+       * An optional reference to the object whose visibility is being tested
+       * @defaultValue `null`
+       */
+      object: TestObject;
+    }>;
+
+    interface CreateTestConfigOptions extends _CreateTestConfigOptions {}
+
+    /** @internal */
+    type _TestConfigOptional = NullishProps<{
+      /**
+       * The target object
+       * @defaultValue `null`
+       * @remarks Only checked in `#_canDetect` for `instanceof Token`
+       */
+      object: TestObject;
+    }>;
+
+    /** @internal */
+    interface _TestConfigRequired {
+      /** An array of visibility tests */
+      tests: CanvasVisibility.Test[];
+    }
+
+    interface TestConfig extends _TestConfigRequired, _TestConfigOptional {}
+
+    interface Test {
+      point: Canvas.Point;
+      elevation: number;
+      los: Map<foundry.canvas.sources.PointVisionSource.Any, boolean>;
+    }
+
+    /**
+     * @privateRemarks This is a fixed subset of `PIXI.IBaseTextureOptions` that `CanvasVisibility##createTextureConfiguration` produces.
+     * Since it's generated by a private method and stored in a private property, it's not meaningfully extensible (`canvas.visibility.textureConfiguration.foo = "bar"` doesn't count)
+     */
+    interface TextureConfiguration {
+      resolution: number;
+      width: number;
+      height: number;
+      mipmap: PIXI.MIPMAP_MODES;
+      multisample: PIXI.MSAA_QUALITY;
+      scaleMode: PIXI.SCALE_MODES;
+      alphaMode: PIXI.ALPHA_MODES;
+      format: PIXI.FORMATS;
+    }
   }
 }
 
 declare abstract class AnyCanvasVisibility extends CanvasVisibility {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

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

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -8,11 +8,10 @@ declare global {
     /**
      * @param options - Options passed to the getParticleEmitters method which can be used to customize values of the emitter configuration.
      *                  (default: `{}`)
+     * @remarks Despite being an `={}` parameter, construction will throw if it is passed (or defaults to via omission) an empty object
      */
     constructor(options: PIXI.particles.EmitterConfigV3);
 
-    parent: PIXI.Container;
-
     emitters: PIXI.particles.Emitter[];
 
     /**
@@ -28,7 +27,8 @@ declare global {
      * Subclasses can override this method for more advanced configurations.
      * @param options - Options provided to the ParticleEffect constructor which can be used to customize
      *                  configuration values for created emitters. (default: `{}`)
-     * @throws An error if `foundry.utils.isEmpty(options)`
+     * @throws If `options` is passed as (or defaults to via omission) an empty object
+     * @remarks Despite its name, this method only takes a single config object and only returns a single-element array.
      */
     getParticleEmitters(options: PIXI.particles.EmitterConfigV3): PIXI.particles.Emitter[];
 
@@ -44,4 +44,13 @@ declare global {
      */
     stop(): void;
   }
+
+  namespace ParticleEffect {
+    interface Any extends AnyParticleEffect {}
+    interface AnyConstructor extends Identity<typeof AnyParticleEffect> {}
+  }
+}
+
+declare abstract class AnyParticleEffect extends ParticleEffect {
+  constructor(...args: never);
 }

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

@@ -1,20 +1,49 @@
-export {};
+import type { Identity } from "fvtt-types/utils";
 
 declare global {
   /**
    * A full-screen weather effect which renders gently falling autumn leaves.
    */
   class AutumnLeavesWeatherEffect extends ParticleEffect {
+    /**
+     * @remarks `options` is completely unused in this subclass, as it gets passed to `#getParticleEmitters`, which, unlike super's method, takes no arguments
+     */
+    constructor(options?: PIXI.particles.EmitterConfigV3 | null);
     /**
      * @defaultValue `"WEATHER.AutumnLeaves"`
+     * @remarks A localization key. Appears to be unused in v12.331, probably vestigial, is identical to the
+     * `label` for the AmbienceConfig containing this effect in `CONFIG.Canvas.weatherEffects`
      */
     static label: string;
 
     /**
      * Configuration for the particle emitter for falling leaves
+     * @remarks Not a complete EmitterConfigV3; the `frequency` and `pos` required keys are omitted. `frequency` is set
+     * up in `#getParticleEmitters`, but `pos` is not; it is erroneously marked as required in the interface,
+     * see https://github.com/pixijs-userland/particle-emitter/issues/219
      */
-    static LEAF_CONFIG: PIXI.particles.EmitterConfigV3;
+    static LEAF_CONFIG: AutumnLeavesWeatherEffect.LeafConfig;
 
+    /** @remarks This does not take a config paramater, unlike its parent class; uses `static LEAF_CONFIG` on this class instead */
     override getParticleEmitters(): PIXI.particles.Emitter[];
   }
+
+  namespace AutumnLeavesWeatherEffect {
+    interface Any extends AnyAutumnLeavesWeatherEffect {}
+    interface AnyConstructor extends Identity<typeof AnyAutumnLeavesWeatherEffect> {}
+
+    /** @internal */
+    interface _EmitterConfigOptionalProperties {
+      pos?: PIXI.particles.EmitterConfigV3["pos"];
+      frequency?: PIXI.particles.EmitterConfigV3["frequency"];
+    }
+
+    interface LeafConfig
+      extends Omit<PIXI.particles.EmitterConfigV3, keyof _EmitterConfigOptionalProperties>,
+        _EmitterConfigOptionalProperties {}
+  }
+}
+
+declare abstract class AnyAutumnLeavesWeatherEffect extends AutumnLeavesWeatherEffect {
+  constructor(...args: never);
 }