@league-of-foundry-developers/foundry-vtt-types 9.238.1 → 9.242.0

package/src/foundry/foundry.js/pointSource.d.ts

@@ -1,31 +1,28 @@
 /**
  * A helper class used by the Sight Layer to represent a source of vision or illumination.
  */
-declare class PointSource {
+declare abstract class PointSource {
   /**
    * @param object - The object responsible for the PointSource
    */
-  constructor(object: PlaceableObject, sourceType: PointSource.SourceType);
+  constructor(object: PlaceableObject);
 
   /**
-   * The object responsible for the PointSource
+   * The object responsible for this source.
    */
   object: PlaceableObject;
 
   /**
-   * The type of source
+   * The type of source represented by this data structure.
+   * Each subclass must implement this attribute.
+   * @remarks This is undefined in PointSource.
    */
-  sourceType: PointSource.SourceType;
+  static sourceType: string | undefined;
 
   /**
-   * The light or darkness container for this source
-   */
-  illumination: PIXI.Container;
-
-  /**
-   * This visible color container for this source
+   * The default Geometry stored in the GPU for all Point Source meshes.
    */
-  coloration: PIXI.Container;
+  static GEOMETRY: PIXI.Geometry;
 
   /**
    * A flag for whether this source is currently active (rendered) or not
@@ -34,22 +31,10 @@ declare class PointSource {
   active: boolean;
 
   /**
-   * The range of Scene darkness values for which this Source should be active
-   * @defaultValue `{ min: 0, max: 0 }`
+   * The object of data which configures how this source is rendered
+   * @defaultValue `{}`
    */
-  darkness: { min: number; max: number };
-
-  /**
-   * Internal flag for whether this is a darkness source
-   * @defaultValue `false`
-   */
-  isDarkness: boolean;
-
-  /**
-   * Is the light source limited by an angle of emission?
-   * @defaultValue `false`
-   */
-  limited: boolean;
+  data: Partial<PointSource.Data>;
 
   /**
    * The maximum radius of emission for this source
@@ -58,357 +43,103 @@ declare class PointSource {
   radius: number;
 
   /**
-   * Internal flag for animation throttling time
-   * @defaultValue `0`
-   * @internal
-   */
-  protected _animateTime: number;
-
-  /**
-   * An integer seed which de-synchronizes otherwise similar animations
-   * @defaultValue `null`
-   * @internal
-   */
-  protected _animateSeed: number | null;
-
-  /**
-   * A flag for the lighting channels version that this source is using.
-   * @defaultValue `0`
-   * @internal
-   */
-  protected _lightingVersion: number;
-
-  /**
-   * A flag for whether to re-initialize illumination shader uniforms the next time the light is rendered.
-   * @defaultValue `true`
-   * @internal
-   */
-  protected _resetIlluminationUniforms: boolean;
-
-  /**
-   * A flag for whether to re-initialize coloration shader uniforms the next time the light is rendered.
-   * @defaultValue `true`
-   *@internal
-   */
-  protected _resetColorationUniforms: boolean;
-
-  /**
-   * An internal flag for whether to render coloration for this source
-   * @defaultValue `false`
-   * @internal
-   */
-  protected _hasColor: boolean;
-
-  /**
-   * The default Geometry stored in the GPU for all Point Source meshes.
-   */
-  static GEOMETRY: PIXI.Geometry;
-
-  /**
-   * Create the structure of a source Container which can be rendered to the sight layer shadow-map
-   * @returns The constructed light source container
-   * @internal
-   */
-  protected _createContainer(shaderCls: ConstructorOf<AbstractBaseShader>): PIXI.Container;
-
-  /**
-   * Initialize the source with provided object data.
-   *
-   * @param data - Input data which configures the source.
-   *
-   * @returns A reference to the initialized source
-   */
-  initialize(data?: PointSource.Data): PointSource.Initialized<this>;
-
-  /**
-   * The x-coordinate of the source location
-   * @defaultValue `undefined`
-   */
-  x?: number;
-
-  /**
-   * The y-coordinate of the source location
+   * The restricted line-of-sight polygon that is generated by the origin and radius of this source.
    * @defaultValue `undefined`
    */
-  y?: number;
+  los: PointSourcePolygon | undefined;
 
   /**
-   * An optional z-index sorting for the source
-   * @defaultValue `undefined`
+   * A Graphics object with pre-computed geometry used for masking based on line-of-sight.
+   * @defaultValue `new PIXI.LegacyGraphics()`
    */
-  z?: number | null;
+  losMask: PIXI.Graphics;
 
   /**
-   * The allowed radius of dim vision or illumination
-   * @defaultValue `undefined`
-   */
-  dim?: number;
-
-  /**
-   * The allowed radius of bright vision or illumination
-   * @defaultValue `undefined`
-   */
-  bright?: number;
-
-  /**
-   * The angle of emission for this point source
-   * @defaultValue `undefined`
-   */
-  angle?: number;
-
-  /**
-   * The angle of rotation for this point source
-   * @defaultValue `undefined`
-   */
-  rotation?: number;
-
-  /**
-   * A tint color for the emitted light, if any
-   * @defaultValue `undefined`
-   */
-  color?: number | null;
-
-  /**
-   * An opacity for the emitted light, if any
-   * @defaultValue `undefined`
-   */
-  alpha?: number;
-
-  /**
-   * The source type from CONST.SOURCE_TYPES
-   * @defaultValue `undefined`
-   */
-  type?: foundry.CONST.SOURCE_TYPES;
-
-  /**
-   * An animation configuration for the source
-   * @defaultValue `undefined`
-   */
-  animation?: PointSource.Animation;
-
-  /**
-   * An integer seed to synchronize (or de-synchronize) animations
-   * @defaultValue `undefined`
-   */
-  seed?: number;
-
-  /**
-   * @defaultValue `undefined`
+   * Is the angle of emission for this source limited?
+   * @defaultValue `false`
    */
-  colorRGB?: [r: number, g: number, b: number];
+  limited: boolean;
 
   /**
-   * @defaultValue `undefined`
+   * Boolean flags which control whether certain behaviors of the source must be enforced
+   * @defaultValue `{}`
    */
-  ratio?: number;
+  protected _flags: {
+    renderFOV?: boolean;
+  } & Record<string, boolean>;
 
   /**
-   * @defaultValue `undefined`
+   * The x-coordinate of the point source origin.
    */
-  fov?: PIXI.Polygon;
+  get x(): number | undefined;
 
   /**
-   * @defaultValue `undefined`
+   * The y-coordinate of the point source origin.
    */
-  los?: PIXI.Polygon;
+  get y(): number | undefined;
 
   /**
-   * Initialize the shaders used for this animation.
-   * Reset the current shader values back to defaults.
-   * Swap to a different Shader instance if necessary.
-   * @internal
+   * The type of source represented by this data structure.
    */
-  protected _initializeShaders(): void;
+  get sourceType(): typeof PointSource['sourceType'];
 
   /**
-   * Initialize the blend mode and vertical sorting of this source relative to others in the container.
-   * @internal
+   * A point is contained with the area of the source if it is within both the FOV circle as well as the LOS polygon.
+   * @param point - The point to test
+   * @returns Is the point contained
    */
-  protected _initializeBlending(): void;
+  containsPoint(point: Point): boolean;
 
   /**
-   * Draw the display of this source for the darkness/light container of the SightLayer.
-   * @returns The rendered light container
+   * Steps that must be performed when the base source is destroyed.
    */
-  drawLight(): PIXI.Container;
+  destroy(): void;
 
-  /**
-   * Draw and return a container used to depict the visible color tint of the light source on the LightingLayer
-   * @returns An updated color container for the source
-   */
-  drawColor(): PIXI.Container;
+  fovTexture?: PIXI.RenderTexture | undefined;
 
-  /**
-   * A common helper function for updating the display of a source container.
-   * Assign the container position, dimensions, and polygons.
-   * @internal
-   */
-  protected _drawContainer(c: PIXI.Container): PIXI.Container;
+  abstract initialize(data?: Partial<PointSource.Data>): this;
 
   /**
-   * Animate the PointSource, if an animation is enabled and if it currently has rendered containers.
-   * @param dt - Delta time
+   * Get power of 2 size pertaining to base-source radius and performance modes
+   * @returns The computed power of 2 size
    */
-  animate(dt: number): void;
+  getPowerOf2Size(): number;
 
   /**
-   * A torch animation where the luminosity and coloration decays each frame and is revitalized by flashes
-   * @param dt        - Delta time
-   * @param speed     - The animation speed, from 1 to 10
-   *                    (default: `5`)
-   * @param intensity - The animation intensity, from 1 to 10
-   *                    (default: `5`)
+   * Create a new Mesh for this source using a provided shader class
+   * @param shaderCls - The subclass of AdaptiveLightingShader being used for this Mesh
+   * @returns The created Mesh
    */
-  animateTorch(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
+  protected _createMesh(shaderCls: ConstructorOf<AdaptiveLightingShader>): PIXI.Mesh;
 
   /**
-   * A basic "pulse" animation which expands and contracts.
-   * @param dt        - Delta time
-   * @param speed     - The animation speed, from 1 to 10
-   *                    (default: `5`)
-   * @param intensity - The animation intensity, from 1 to 10
-   *                    (default: `5`)
+   * Update the position and size of the mesh each time it is drawn.
+   * @param mesh - The Mesh being updated
+   * @returns The updated Mesh
    */
-  animatePulse(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
+  protected _updateMesh(mesh: PIXI.Mesh): PIXI.Mesh;
 
   /**
-   * Emanate waves of light from the source origin point
-   * @param dt        - Delta time
-   * @param speed     - The animation speed, from 1 to 10
-   *                    (default: `5`)
-   * @param intensity - The animation intensity, from 1 to 10
-   *                    (default: `5`)
+   * Render this source to a texture which can be used for masking and blurring.
    */
-  animateTime(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
+  protected _renderTexture(): PIXI.RenderTexture;
 
   /**
-   * Evolve a value using a stochastic AR(1) process
-   * @param y      - The current value
-   * @param phi    - The decay rate of prior values
-   * @param center - The stationary mean of the series
-   * @param sigma  - The volatility of the process - standard deviation of the error term
-   * @param max    - The maximum allowed outcome, or null
-   * @param min    - The minimum allowed outcome, or null
-   * @returns The new value of the process
-   * @internal
+   * Create a container that should be rendered to the fov texture for this source
+   * @returns The drawn container for the render texture
    */
-  protected _ar1(
-    y: number,
-    {
-      phi,
-      center,
-      sigma,
-      max,
-      min
-    }: { phi?: number; center?: number; sigma?: number; max?: number | null; min?: number | null }
-  ): number;
+  protected _drawRenderTextureContainer(): PIXI.Container;
 }
 
 declare namespace PointSource {
-  type SourceType = 'light' | 'sight';
-
   interface Data {
-    /**
-     * The x-coordinate of the source location
-     * @defaultValue `0`
-     */
+    /** The x-coordinate of the source location */
     x?: number;
 
-    /** The y-coordinate of the source location
-     * @defaultValue `0`
-     */
+    /** The y-coordinate of the source location */
     y?: number;
 
-    /** An optional z-index sorting for the source
-     * @defaultValue `null`
-     */
-    z?: number | null;
-
-    /** The allowed radius of dim vision or illumination
-     * @defaultValue `0`
-     */
-    dim?: number;
-
-    /** The allowed radius of bright vision or illumination
-     * @defaultValue `0`
-     */
-    bright?: number;
-
-    /** The angle of emission for this point source
-     * @defaultValue `360`
-     */
-    angle?: number;
-
-    /**
-     * The angle of rotation for this point source
-     * @defaultValue `0`
-     */
-    rotation?: number;
-
-    /**
-     * A tint color for the emitted light, if any
-     * @defaultValue `null`
-     */
-    color?: number | string | null;
-
-    /** An opacity for the emitted light, if any
-     * @defaultValue `0.5`
-     */
-    alpha: number;
-
-    /**
-     * A darkness range (min and max) for which the source should be active
-     * @defaultValue `{ min: 0, max: 1 }`
-     */
-    darkness?: { min: number; max: number };
-
-    /**
-     * The source type from CONST.SOURCE_TYPES
-     * @defaultValue `CONST.SOURCE_TYPES.LOCAL`
-     */
-    type?: foundry.CONST.SOURCE_TYPES;
-
-    /**
-     * An animation configuration for the source
-     * @defaultValue `{ type: null }`
-     */
-    animation?: PointSource.Animation;
-
-    /**
-     * An integer seed to synchronize (or de-synchronize) animations
-     */
-    seed?: number;
+    /** Whether or not the source is constrained by walls */
+    walls?: boolean;
   }
-
-  type Initialized<P extends PointSource> = P &
-    Required<
-      Pick<
-        P,
-        | 'animation'
-        | 'angle'
-        | 'alpha'
-        | 'bright'
-        | 'color'
-        | 'dim'
-        | 'rotation'
-        | 'type'
-        | 'x'
-        | 'y'
-        | 'z'
-        | 'colorRGB'
-        | 'ratio'
-        | 'fov'
-        | 'los'
-      >
-    >;
-
-  interface AnimationProperties {
-    speed?: number;
-    intensity?: number;
-  }
-  interface Animation extends AnimationProperties {
-    type: null | keyof typeof CONFIG.Canvas.lightAnimations;
-  }
-
-  type AnimationFunction = (this: PointSource, dt: number, { speed, intensity }?: AnimationProperties) => void;
 }

package/src/foundry/foundry.js/pointSources/index.d.ts

@@ -0,0 +1,3 @@
+import './lightSource';
+import './soundSource';
+import './visionSource';