Update EffectSource types for V13 (#19180)

Author: stwlam

types/foundry/client/_types.d.mts

@@ -8,6 +8,7 @@ import { AVSettingsData } from "./av/settings.mjs";
 import { CanvasAnimationData, CanvasAnimationEasingFunction } from "./canvas/animation/_types.mjs";
 import { Ray } from "./canvas/geometry/_module.mjs";
 import { PingData } from "./canvas/interaction/_types.mjs";
+import AmbientLight from "./canvas/placeables/light.mjs";
 import Token, { TokenShape } from "./canvas/placeables/token.mjs";
 import PointVisionSource from "./canvas/sources/point-vision-source.mjs";
 import Roll from "./dice/roll.mjs";
@@ -1077,7 +1078,7 @@ export interface CanvasViewPosition {
 
 export interface CanvasVisibilityTest {
     point: ElevatedPoint;
-    los: Map<PointVisionSource, boolean>;
+    los: Map<PointVisionSource<Token | AmbientLight>, boolean>;
 }
 
 export interface CanvasVisibilityTestConfiguration {

types/foundry/client/canvas/groups/effects.d.mts

@@ -53,7 +53,7 @@ export default class EffectsCanvasGroup extends CanvasGroupMixin(PIXI.Container)
     initializeLightSources(): void;
 
     /** Update the global light source which provide global illumination to the Scene. */
-    protected _updateGlobalLightSource(): PointLightSource<null>;
+    protected _updateGlobalLightSource(): GlobalLightSource;
 
     /** Refresh the state and uniforms of all LightSource objects. */
     refreshLightSources(): void;

types/foundry/client/canvas/groups/visibility.d.mts

@@ -2,6 +2,7 @@ import { PointVisionSource } from "@client/canvas/sources/_module.mjs";
 import { Point } from "@common/_types.mjs";
 import { CanvasVisibilityTestConfiguration, CanvasVisibilityTextureConfiguration } from "../../_types.mjs";
 import { CanvasVisionContainer } from "../layers/_types.mjs";
+import { AmbientLight, Token } from "../placeables/_module.mjs";
 import CanvasGroupMixin from "./canvas-group-mixin.mjs";
 
 /**
@@ -36,7 +37,7 @@ export default class CanvasVisibility extends CanvasGroupMixin(PIXI.Container) {
     /**
      * The active vision source data object
      */
-    visionModeData: { source: PointVisionSource | null; activeLightingOptions: object };
+    visionModeData: { source: PointVisionSource<AmbientLight | Token> | null; activeLightingOptions: object };
 
     /**
      * Define whether each lighting layer is enabled, required, or disabled by this vision mode.

types/foundry/client/canvas/layers/_types.d.mts

@@ -10,7 +10,7 @@ export interface AmbientSoundPlaybackConfig {
     /** The Sound node which should be controlled for playback */
     sound: Sound;
     /** The SoundSource which defines the area of effect for the sound */
-    source: PointSoundSource;
+    source: PointSoundSource<AmbientSound>;
     /** An AmbientSound object responsible for the sound, or undefined */
     object?: AmbientSound;
     /** The coordinates of the closest listener or undefined if there is none */

types/foundry/client/canvas/layers/sounds.d.mts

@@ -25,7 +25,7 @@ export default class SoundsLayer<TObject extends AmbientSound = AmbientSound> ex
     livePreview: boolean;
 
     /** A mapping of ambient audio sources which are active within the rendered Scene */
-    sources: Collection<string, PointSoundSource>;
+    sources: Collection<string, PointSoundSource<TObject>>;
 
     static override get layerOptions(): PlaceablesLayerOptions;
 

types/foundry/client/canvas/perception/detection-mode.d.mts

@@ -104,7 +104,7 @@ export default class DetectionMode extends foundry.abstract.DataModel<null, Dete
      * @returns                       Is the point within the vision angle?
      */
     protected _testAngle(
-        visionSource: PointVisionSource,
+        visionSource: PointVisionSource<Token>,
         mode: TokenDetectionMode,
         target: PlaceableObject,
         test: CanvasVisibilityTest,

types/foundry/client/canvas/perception/detection-modes/darkvision.d.mts

@@ -1,4 +1,4 @@
-import { PlaceableObject } from "../../placeables/_module.mjs";
+import { PlaceableObject, Token } from "../../placeables/_module.mjs";
 import PointVisionSource from "../../sources/point-vision-source.mjs";
 import DetectionMode from "../detection-mode.mjs";
 
@@ -7,5 +7,5 @@ import DetectionMode from "../detection-mode.mjs";
  * This mode is the default case which is tested first when evaluating visibility of objects.
  */
 export default class DetectionModeDarkvision extends DetectionMode {
-    protected override _canDetect(visionSource: PointVisionSource, target: PlaceableObject): boolean;
+    protected override _canDetect(visionSource: PointVisionSource<Token>, target: PlaceableObject): boolean;
 }

types/foundry/client/canvas/perception/vision-mode.d.mts

@@ -56,13 +56,13 @@ export default class VisionMode extends DataModel<null, VisionModeSchema> {
      * Special activation handling that could be implemented by VisionMode subclasses
      * @param source   Activate this VisionMode for a specific source
      */
-    _activate(source: PointVisionSource): void;
+    _activate(source: PointVisionSource<Token>): void;
 
     /**
      * Special deactivation handling that could be implemented by VisionMode subclasses
      * @param source   Deactivate this VisionMode for a specific source
      */
-    protected _deactivate(source: PointVisionSource): void;
+    protected _deactivate(source: PointVisionSource<Token>): void;
 
     /**
      * Special handling which is needed when this Vision Mode is activated for a VisionSource.

types/foundry/client/canvas/placeables/light.d.mts

@@ -4,64 +4,91 @@ import {
     DatabaseDeleteCallbackOptions,
     DatabaseUpdateCallbackOptions,
 } from "@common/abstract/_types.mjs";
+import { LightData } from "@common/data/_module.mjs";
 import { ControlIcon } from "../containers/_module.mjs";
+import { RenderFlag } from "../interaction/_types.mjs";
 import { LightingLayer } from "../layers/_module.mjs";
 import { PointDarknessSource, PointLightSource } from "../sources/_module.mjs";
+import { LightSourceData } from "../sources/base-light-source.mjs";
 import PlaceableObject from "./placeable-object.mjs";
 
 export default class AmbientLight<
     TDocument extends AmbientLightDocument<Scene | null> = AmbientLightDocument<Scene | null>,
 > extends PlaceableObject<TDocument> {
-    constructor(document: TDocument);
+    static override embeddedName: "AmbientLight";
+
+    static override RENDER_FLAGS: Record<string, Partial<RenderFlag>>;
 
-    /** The area that is affected by this light */
+    /**
+     * The area that is affected by this light
+     */
     field: PIXI.Graphics;
 
     /**
      * A reference to the PointSource object which defines this light or darkness area of effect.
      * This is undefined if the AmbientLight does not provide an active source of light.
      */
-    lightSource?: PointDarknessSource<this> | PointLightSource<this>;
-
-    /** A reference to the ControlIcon used to configure this light */
-    controlIcon: ControlIcon;
-
-    static override embeddedName: "AmbientLight";
+    lightSource: PointDarknessSource<this> | PointLightSource<this> | undefined;
 
     override get bounds(): PIXI.Rectangle;
 
-    /** A convenience accessor to the LightData configuration object */
-    get config(): TDocument["config"];
+    /**
+     * A convenience accessor to the LightData configuration object
+     */
+    get config(): LightData<TDocument>;
 
-    /** Test whether a specific AmbientLight source provides global illumination */
+    /**
+     * Test whether a specific AmbientLight source provides global illumination
+     */
     get global(): boolean;
 
-    /** The maximum radius in pixels of the light field */
+    /**
+     * The maximum radius in pixels of the light field
+     */
     get radius(): number;
 
-    /** Get the pixel radius of dim light emitted by this light source */
+    /**
+     * Get the pixel radius of dim light emitted by this light source
+     */
     get dimRadius(): number;
 
-    /** Get the pixel radius of bright light emitted by this light source */
+    /**
+     * Get the pixel radius of bright light emitted by this light source
+     */
     get brightRadius(): number;
 
-    /** Is this ambient light is currently visible based on its hidden state and the darkness level of the Scene? */
+    /**
+     * Is this Ambient Light currently visible? By default, true only if the source actively emits light or darkness.
+     */
     get isVisible(): boolean;
 
-    /** Check if the point source is a LightSource instance */
+    /**
+     * Check if the point source is a LightSource instance
+     */
     get isLightSource(): boolean;
 
-    /** Check if the point source is a DarknessSource instance */
+    /**
+     * Check if the point source is a DarknessSource instance
+     */
     get isDarknessSource(): boolean;
 
-    /** Does this Ambient Light actively emit darkness light given its properties and the current darkness level of the Scene?  */
+    /**
+     * Does this Ambient Light actively emit darkness light given
+     * its properties and the current darkness level of the Scene?
+     */
     get emitsDarkness(): boolean;
 
     /**
-     * Does this Ambient Light actively emit light given its properties and the current darkness level of the Scene?
+     * Does this Ambient Light actively emit positive light given
+     * its properties and the current darkness level of the Scene?
      */
     get emitsLight(): boolean;
 
+    /**
+     * Is the source of this Ambient Light disabled?
+     */
+    protected _isLightSourceDisabled(): boolean;
+
     /* -------------------------------------------- */
     /* Rendering                                    */
     /* -------------------------------------------- */

types/foundry/client/canvas/placeables/placeable-object.d.mts

@@ -33,7 +33,7 @@ export default abstract class PlaceableObject<
     document: TDocument;
 
     /** A control icon for interacting with the object */
-    controlIcon: ControlIcon;
+    controlIcon: ControlIcon | null;
 
     /** A mouse interaction manager instance which handles mouse workflows related to this object. */
     mouseInteractionManager: MouseInteractionManager;