@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

package/src/foundry/client/pixi/sources/light-source.d.ts

@@ -1,413 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /** @see {@link foundry.data.LightData} */
-  interface LightSourceData extends PointSource.Data {
-    /** @defaultValue `0` */
-    x: number;
-
-    /** @defaultValue `0` */
-    y: number;
-
-    /**
-     * An optional z-index sorting for the source
-     * @defaultValue `null`
-     */
-    z: number | null;
-
-    /**
-     * The angle of rotation for this point source
-     * @defaultValue `0`
-     */
-    rotation: number;
-
-    /**
-     * An opacity for the emitted light, if any
-     * @defaultValue `0.5`
-     */
-    alpha: number;
-
-    /**
-     * An animation configuration for the source
-     * @defaultValue `{ type: null }`
-     */
-    animation: LightAnimationConfiguration;
-
-    /**
-     * The angle of emission for this point source
-     * @defaultValue `360`
-     */
-    angle: number;
-
-    /**
-     * The allowed radius of bright vision or illumination
-     * @defaultValue `0`
-     */
-    bright: number;
-
-    /**
-     * A tint color for the emitted light, if any
-     * @defaultValue `null`
-     */
-    color: number | null;
-
-    /**
-     * The coloration technique applied in the shader
-     * @defaultValue `1`
-     */
-    coloration: number;
-
-    /**
-     * The amount of contrast this light applies to the background texture
-     * @defaultValue `0.0`
-     */
-    contrast: 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 allowed radius of dim vision or illumination
-     * @defaultValue `0`
-     */
-    dim: number;
-
-    /** Fade the difference between bright, dim, and dark gradually? */
-    gradual: boolean;
-
-    /**
-     * The luminosity applied in the shader
-     * @defaultValue `0.0`
-     */
-    luminosity: number;
-
-    /**
-     * The amount of color saturation this light applies to the background texture
-     * @defaultValue `0.0`
-     */
-    saturation: number;
-
-    /**
-     * The depth of shadows this light applies to the background texture
-     * @defaultValue `0.0`
-     */
-    shadows: number;
-
-    /** @defaultValue `true` */
-    walls: boolean;
-
-    /**
-     * Whether or not this source provides a source of vision
-     * @defaultValue `false`
-     */
-    vision: boolean;
-
-    /** An integer seed to synchronize (or de-synchronize) animations */
-    seed: number;
-  }
-
-  interface LightAnimationConfiguration {
-    /** The human-readable (localized) label for the animation */
-    label: string;
-
-    /** The animation function that runs every frame */
-    animation: (this: LightSource, dt: number, animation: LightAnimationConfiguration) => void;
-
-    /** A custom illumination shader used by this animation */
-    illuminationShader: AdaptiveIlluminationShader;
-
-    /** A custom coloration shader used by this animation */
-    colorationShader: AdaptiveColorationShader;
-
-    /** A custom background shader used by this animation */
-    backgroundShader: AdaptiveBackgroundShader;
-
-    /** The animation seed */
-    seed?: number;
-
-    /** The animation time */
-    time?: number;
-
-    /** @defaultValue `null` */
-    type?: keyof typeof CONFIG.Canvas.lightAnimations | null;
-  }
-
-  /**
-   * A specialized subclass of the PointSource abstraction which is used to control the rendering of light sources.
-   */
-  class LightSource extends PointSource {
-    /** @param object - The light-emitting object that generates this light source */
-    constructor(object: InstanceType<ConfiguredObjectClassForName<'AmbientLight' | 'Token'>>);
-
-    /**
-     * The light or darkness container for this source
-     * @defaultValue `this._createMesh(AdaptiveBackgroundShader)`
-     */
-    background: PIXI.Mesh;
-
-    /**
-     * The light or darkness container for this source
-     * @defaultValue `this._createMesh(AdaptiveIlluminationShader)`
-     */
-    illumination: PIXI.Mesh;
-
-    /**
-     * This visible color container for this source
-     * @defaultValue `this._createMesh(AdaptiveColorationShader)`
-     */
-    coloration: PIXI.Mesh;
-
-    static override sourceType: 'light';
-
-    /**
-     * Strength of the blur for light source edges
-     * @defaultValue `3`
-     */
-    static BLUR_STRENGTH: number;
-
-    /**
-     * Keys in the LightSourceData structure which, when modified, change the appearance of the light
-     * @internal
-     * @defaultValue
-     * ```javascript
-     * [
-     *   "dim", "bright", "gradual", "alpha", "coloration", "color",
-     *   "contrast", "saturation", "shadows", "luminosity"
-     * ]
-     * ```
-     */
-    protected static _appearanceKeys: string[];
-
-    /**
-     * The object of data which configures how the source is rendered
-     * @defaultValue `{}`
-     */
-    data: Partial<LightSourceData>;
-
-    /**
-     * The animation configuration applied to this source
-     * @defaultValue `{}`
-     */
-    animation: LightAnimationConfiguration;
-
-    /**
-     * Internal flag for whether this is a darkness source
-     * @defaultValue `false`
-     */
-    isDarkness: boolean;
-
-    /**
-     * The rendered field-of-vision texture for the source for use within shaders.
-     * @defaultValue `undefined`
-     */
-    fovTexture: PIXI.RenderTexture | undefined;
-
-    /**
-     * To know if a light source is a preview or not. False by default.
-     * @defaultValue `false`
-     */
-    preview: boolean;
-
-    /**
-     * The ratio of dim:bright as part of the source radius
-     * @defaultValue `undefined`
-     */
-    ratio: number | undefined;
-
-    /**
-     * Track which uniforms need to be reset
-     * @internal
-     * @defaultValue
-     * ```javascript
-     * {
-     *   background: true,
-     *   illumination: true,
-     *   coloration: true
-     * }
-     * ```
-     */
-    protected _resetUniforms: {
-      background: boolean;
-      illumination: boolean;
-      coloration: boolean;
-    };
-
-    /**
-     * To track if a source is temporarily shutdown to avoid glitches
-     * @defaultValue `{ illumination: false }`
-     * @internal
-     */
-    protected _shutdown: { illumination: boolean };
-
-    /**
-     * Initialize the source with provided object data.
-     * @param data - Initial data provided to the point source
-     * @returns A reference to the initialized source
-     */
-    initialize(data?: Partial<LightSourceData> & { color?: string | number | null }): this;
-
-    /**
-     * Initialize the PointSource with new input data
-     * @param data - Initial data provided to the light source
-     * @returns The changes compared to the prior data
-     * @internal
-     */
-    protected _initializeData(
-      data: Partial<LightSourceData> & { color?: string | number | null }
-    ): Partial<LightSourceData>;
-
-    /**
-     * Initialize the shaders used for this source, swapping to a different shader if the animation has changed.
-     * @internal
-     */
-    protected _initializeShaders(): void;
-
-    /**
-     * Initialize the blend mode and vertical sorting of this source relative to others in the container.
-     * @internal
-     */
-    protected _initializeBlending(): void;
-
-    /**
-     * Render the containers used to represent this light source within the LightingLayer
-     */
-    drawMeshes(): {
-      background: ReturnType<LightSource['drawBackground']>;
-      light: ReturnType<LightSource['drawLight']>;
-      color: ReturnType<LightSource['drawColor']>;
-    };
-
-    /**
-     * Draw the display of this source for background container.
-     * @returns The rendered light container
-     */
-    drawBackground(): PIXI.Container | null;
-
-    /**
-     * Draw the display of this source for the darkness/light container of the SightLayer.
-     * @returns The rendered light container
-     */
-    drawLight(): PIXI.Container | null;
-
-    /**
-     * 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 | null;
-
-    /**
-     * Update shader uniforms by providing data from this PointSource
-     * @param shader - The shader being updated
-     * @internal
-     */
-    protected _updateColorationUniforms(shader: AdaptiveColorationShader): void;
-
-    /**
-     * Update shader uniforms by providing data from this PointSource
-     * @param shader - The shader being updated
-     * @internal
-     */
-    protected _updateIlluminationUniforms(shader: AdaptiveIlluminationShader): void;
-
-    /**
-     * Update shader uniforms by providing data from this PointSource
-     * @param shader - The shader being updated
-     * @internal
-     */
-    protected _updateBackgroundUniforms(shader: AdaptiveBackgroundShader): void;
-
-    /**
-     * Update shader uniforms shared by all shader types
-     * @param shader - The shader being updated
-     * @internal
-     */
-    protected _updateCommonUniforms(shader: AdaptiveLightingShader): void;
-
-    /**
-     * Map luminosity value to exposure value
-     * luminosity[-1  , 0  [ =\> Darkness =\> map to exposure ]   0, 1]
-     * luminosity[ 0  , 0.5[ =\> Light    =\> map to exposure [-0.5, 0[
-     * luminosity[ 0.5, 1  ] =\> Light    =\> map to exposure [   0, 1]
-     * @param lum - The luminosity value
-     * @returns The exposure value
-     * @internal
-     */
-    protected _mapLuminosity(lum: number): number;
-
-    /**
-     * Animate the PointSource, if an animation is enabled and if it currently has rendered containers.
-     * @param dt - Delta time
-     */
-    animate(dt: number): void;
-
-    /**
-     * 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`)
-     */
-    animateTorch(dt: number, { speed, intensity }?: { speed: number; intensity: number }): void;
-
-    /**
-     * 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`)
-     * @param reverse   - Is the animation reversed?
-     *                    (default: `false`)
-     */
-    animatePulse(
-      dt: number,
-      { speed, intensity, reverse }?: { speed?: number; intensity?: number; reverse?: boolean }
-    ): void;
-
-    /**
-     * 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`)
-     * @param reverse   - Is the animation reversed?
-     *                    (default: `false`)
-     */
-    animateTime(
-      dt: number,
-      { speed, intensity, reverse }?: { speed?: number; intensity?: number; reverse?: boolean }
-    ): void;
-
-    /**
-     * Evolve a value using a stochastic AR(1) process
-     * @param y      - The current value
-     * @param phi    - The decay rate of prior values
-     *                 (default: `0.5`)
-     * @param center - The stationary mean of the series
-     *                 (default: `0`)
-     * @param sigma  - The volatility of the process - standard deviation of the error term
-     *                 (default: `0.1`)
-     * @param max    - The maximum allowed outcome, or null
-     *                 (default: `null`)
-     * @param min    - The minimum allowed outcome, or null
-     *                 (default: `null`)
-     * @returns The new value of the process
-     * @internal
-     */
-    protected _ar1(
-      y: number,
-      {
-        phi,
-        center,
-        sigma,
-        max,
-        min
-      }?: { phi?: number; center?: number; sigma?: number; max?: number | null; min?: number | null }
-    ): number;
-  }
-}

package/src/foundry/client/pixi/sources/sound-source.d.ts

@@ -1,45 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  interface SoundSourceData extends PointSource.Data {
-    x: number;
-
-    y: number;
-
-    /** The radius of the sound effect */
-    radius: number;
-
-    walls: boolean;
-  }
-
-  /**
-   * A specialized subclass of the PointSource abstraction which is used to control the rendering of sound sources.
-   */
-  class SoundSource extends PointSource {
-    /** @param object - The AmbientSound object that generates this sound source */
-    constructor(object: InstanceType<ConfiguredObjectClassForName<'AmbientSound'>>);
-
-    static override sourceType: 'sound';
-
-    /**
-     * The object of data which configures how the source is rendered
-     * @defaultValue `{}`
-     */
-    data: Partial<SoundSourceData>;
-
-    /**
-     * Initialize the source with provided object data.
-     * @param data - Initial data provided to the point source
-     * @returns A reference to the initialized source
-     */
-    initialize(data?: Partial<SoundSourceData>): this;
-
-    /**
-     * Process new input data provided to the SoundSource.
-     * @param data - Initial data provided to the sound source
-     * @returns The changes compared to the prior data
-     * @internal
-     */
-    protected _initializeData(data: Partial<SoundSourceData>): void;
-  }
-}

package/src/foundry/client/pixi/sources/vision-source.d.ts

@@ -1,123 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  interface VisionSourceData extends Exclude<PointSource.Data, 'walls'> {
-    x: number;
-
-    y: number;
-
-    /** An optional z-index sorting for the source */
-    z: number;
-
-    /** The angle of rotation for this point source */
-    rotation: number;
-
-    /** The angle of emission for this point source */
-    angle: number;
-
-    /** The allowed radius of bright vision or illumination */
-    bright: number;
-
-    /** The allowed radius of dim vision or illumination */
-    dim: number;
-  }
-
-  /**
-   * A specialized subclass of the PointSource abstraction which is used to control the rendering of vision sources.
-   */
-  class VisionSource extends PointSource {
-    /** @param object - The Token object that generates this vision source */
-    constructor(object: InstanceType<ConfiguredObjectClassForName<'Token'>>);
-
-    /**
-     * The current vision mesh for this source
-     * @defaultValue `this._createMesh(AdaptiveIlluminationShader)`
-     */
-    illumination: PIXI.Mesh;
-
-    static override sourceType: 'vision';
-
-    /**
-     * Keys in the VisionSourceData structure which, when modified, change the appearance of the source
-     * @defaultValue `["dim", "bright"]`
-     * @internal
-     */
-    protected static _appearanceKeys: string[];
-
-    /**
-     * The object of data which configures how the source is rendered
-     * @defaultValue `{}`
-     */
-    data: Partial<VisionSourceData>;
-
-    /**
-     * The ratio of dim:bright as part of the source radius
-     * @defaultValue `undefined`
-     */
-    ratio: number | undefined;
-
-    /**
-     * The rendered field-of-vision texture for the source for use within shaders.
-     * @defaultValue `undefined`
-     */
-    fovTexture: PIXI.RenderTexture | undefined;
-
-    /**
-     * Track which uniforms need to be reset
-     * @defaultValue `{ illumination: true }`
-     * @internal
-     */
-    protected _resetUniforms: { illumination: boolean };
-
-    /**
-     * To track if a source is temporarily shutdown to avoid glitches
-     * @defaultValue `{ illumination: false }`
-     * @internal
-     */
-    protected _shutdown: { illumination: boolean };
-
-    /**
-     * Initialize the source with provided object data.
-     * @param data - Initial data provided to the point source
-     * @returns A reference to the initialized source
-     */
-    initialize(data?: Partial<VisionSourceData>): this;
-
-    fov?: PIXI.Circle;
-
-    /**
-     * Initialize the blend mode and vertical sorting of this source relative to others in the container.
-     * @internal
-     */
-    protected _initializeBlending(): void;
-
-    /**
-     * Process new input data provided to the LightSource.
-     * @param data - Initial data provided to the vision source
-     * @returns The changes compared to the prior data
-     * @internal
-     */
-    protected _initializeData(data: Partial<VisionSourceData>): Partial<VisionSourceData>;
-
-    /**
-     * Draw the display of this source to remove darkness from the LightingLayer illumination container.
-     * @see LightSource#drawLight
-     * @returns The rendered light container
-     */
-    drawVision(): PIXI.Container | null;
-
-    /**
-     * Draw a Container used for exploring the FOV area of Token sight in the SightLayer
-     */
-    drawSight(): PIXI.Container;
-
-    /**
-     * Update shader uniforms by providing data from this PointSource
-     * @param shader - The shader being updated
-     * @internal
-     */
-    protected _updateIlluminationUniforms(shader: AdaptiveIlluminationShader): void;
-
-    protected override _drawRenderTextureContainer(): PIXI.Container;
-  }
-}

package/src/foundry/client/pixi/webgl/base.d.ts

@@ -1,69 +0,0 @@
-/**
- * This class defines an interface which all shaders utilize
- */
-declare abstract class AbstractBaseShader extends PIXI.Shader {
-  /** The current uniforms of the Shader */
-  uniforms: AbstractBaseShader.Uniforms;
-
-  constructor(program: PIXI.Program, uniforms: AbstractBaseShader.Uniforms);
-
-  /**
-   * The initial default values of shader uniforms
-   */
-  protected _defaults: AbstractBaseShader.Uniforms;
-
-  /**
-   * The raw vertex shader used by this class.
-   * A subclass of AbstractBaseShader must implement the vertexShader static field.
-   * @defaultValue `""`
-   *
-   * @remarks This is abstract, subclasses must implement it.
-   */
-  static vertexShader: string;
-
-  /**
-   * The raw fragment shader used by this class.
-   * A subclass of AbstractBaseShader must implement the fragmentShader static field.
-   * @defaultValue `""`
-   *
-   * @remarks This is abstract, subclasses must implement it.
-   */
-  static fragmentShader: string;
-
-  /**
-   * The default uniform values for the shader.
-   * A subclass of AbstractBaseShader must implement the defaultUniforms static field.
-   * @defaultValue `{}`
-   *
-   * @remarks This is abstract, subclasses must implement it.
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  /**
-   * A factory method for creating the shader using its defined default values
-   */
-  static create<T extends AbstractBaseShader>(this: ConstructorOf<T>, defaultUniforms?: AbstractBaseShader.Uniforms): T;
-
-  /**
-   * Reset the shader uniforms back to their provided default values
-   * @internal
-   */
-  protected reset(): void;
-}
-
-declare namespace AbstractBaseShader {
-  type UniformValue =
-    | boolean
-    | number
-    | Int32List
-    | Float32List
-    | { x: number; y: number }
-    | { x: number; y: number; z: number }
-    | { x: number; y: number; z: number; w: number }
-    | { x: number; y: number }[]
-    | { x: number; y: number; z: number }[]
-    | { x: number; y: number; z: number; w: number }[]
-    | PIXI.Texture;
-
-  type Uniforms = Record<string, AbstractBaseShader.UniformValue>;
-}

package/src/foundry/client/pixi/webgl/blend_modes.d.ts

@@ -1,33 +0,0 @@
-declare const BLEND_MODES: {
-  /**
-   * A custom blend mode equation which chooses the maximum color from each channel within the stack.
-   * @defaultValue
-   * ```typescript
-   * [
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.MAX,
-   *   WebGL2RenderingContext.MAX,
-   * ]
-   * ```
-   */
-  MAX_COLOR: [GLenum, GLenum, GLenum, GLenum, GLenum, GLenum];
-
-  /**
-   * A custom blend mode equation which chooses the minimum color from each channel within the stack.
-   * @defaultValue
-   * ```typescript
-   * [
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.ONE,
-   *   WebGL2RenderingContext.MIN,
-   *   WebGL2RenderingContext.MAX,
-   * ]
-   * ```
-   */
-  MIN_COLOR: [GLenum, GLenum, GLenum, GLenum, GLenum, GLenum];
-};