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

package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts

@@ -1,294 +0,0 @@
-import type { NullishProps, IntentionalPartial, AnyObject, Identity } from "fvtt-types/utils";
-
-/**
- * TODO - Re-document after ESM refactor.
- * An abstract base class which defines a framework for effect sources which originate radially from a specific point.
- * This abstraction is used by the LightSource, VisionSource, SoundSource, and MovementSource subclasses.
- *
- * @example A standard PointSource lifecycle:
- * ```js
- * const source = new PointSource({object}); // Create the point source
- * source.initialize(data);                  // Configure the point source with new data
- * source.refresh();                         // Refresh the point source
- * source.destroy();                         // Destroy the point source
- * ```
- * @privateRemarks The TODO is foundry's
- */
-declare abstract class BaseEffectSource<
-  SourceData extends BaseEffectSource.SourceData,
-  SourceShape extends PIXI.Polygon,
-> {
-  /**
-   * An effect source is constructed by providing configuration options.
-   * @param options - Options which modify the base effect source instance
-   * @remarks Passing a PlaceableObject is deprecated, and will be removed in v13
-   */
-  // not null (property access)
-  constructor(options?: BaseEffectSource.ConstructorOptions | PlaceableObject);
-
-  /**
-   * The type of source represented by this data structure.
-   * Each subclass must implement this attribute.
-   * @remarks Effectively abstract, must be defined by subclasses; `undefined` in `BaseEffectSource`
-   */
-  static sourceType: string | undefined;
-
-  /**
-   * The target collection into the effects canvas group.
-   * @remarks Foundry marked `@abstract`; Is `undefined` in `BaseEffectSource`
-   */
-  static effectsCollection: string | undefined;
-
-  /**
-   * Effect source default data.
-   * @defaultValue
-   * ```js
-   * {
-   *   x: 0,
-   *   y: 0,
-   *   elevation: 0,
-   *   disabled: false
-   * }
-   * ```
-   */
-  static defaultData: BaseEffectSource.SourceData;
-
-  /**
-   * Some other object which is responsible for this source.
-   * @privateRemarks In Foundry practice this appears to only ever be `null`, `Token.Implementation`, or `EffectsCanvasGroup` in v12
-   */
-  object: PlaceableObject.Any | CanvasGroupMixin.AnyMixed | null;
-
-  /**
-   * The source id linked to this effect source.
-   * @remarks Foundry types this as Readonly<string>, but does nothing to that effect at runtime
-   */
-  sourceId: string | undefined;
-
-  /**
-   * The data of this source.
-   */
-  data: SourceData;
-
-  /**
-   * The geometric shape of the effect source which is generated later.
-   * @remarks This only isn't `undefined` in subclasses implementing `_createShapes()`, usually via {@link foundry.canvas.sources.PointEffectSourceMixin | `PointEffectSourceMixin`}
-   */
-  shape: SourceShape | undefined;
-
-  /**
-   * A collection of boolean flags which control rendering and refresh behavior for the source.
-   * @defaultValue `{}`
-   */
-  protected _flags: BaseEffectSource.Flags;
-
-  /**
-   * The x-coordinate of the point source origin.
-   */
-  get x(): number;
-
-  /**
-   * The y-coordinate of the point source origin.
-   */
-  get y(): number;
-
-  /**
-   * The elevation bound to this source.
-   */
-  get elevation(): number;
-
-  /**
-   * The EffectsCanvasGroup collection linked to this effect source.
-   */
-  get effectsCollection(): foundry.utils.Collection<this>;
-
-  /**
-   * Returns the update ID associated with this source.
-   * The update ID is increased whenever the shape of the source changes.
-   */
-  get updateId(): number;
-
-  /**
-   * Is this source currently active?
-   * A source is active if it is attached to an effect collection and is not disabled or suppressed.
-   */
-  get active(): boolean;
-
-  /**
-   * Is this source attached to an effect collection?
-   */
-  get attached(): boolean;
-
-  /**
-   * Is this source temporarily suppressed?
-   */
-  get suppressed(): boolean;
-
-  /**
-   * Records of suppression strings with a boolean value.
-   * If any of this record is true, the source is suppressed.
-   * @defaultValue `{}`
-   */
-  suppression: Record<string, boolean>;
-
-  /**
-   * Initialize and configure the source using provided data.
-   * @param data    - Provided data for configuration
-   * @param options - Additional options which modify source initialization
-   * @returns The initialized source
-   */
-  // options: not null (destructured)
-  initialize(data?: NullishProps<SourceData> | null, options?: BaseEffectSource.InitializeOptions): this;
-
-  /**
-   * Subclass specific data initialization steps.
-   * @param data - Provided data for configuration
-   * @remarks Not actually `abstract`, but a is a no-op in `BaseEffectSource`
-   */
-  protected _initialize(
-    /** @privateRemarks `IntentionalPartial` because `#initialize` has filtered invalid keys and replaced any nullish values before calling this */
-    data: IntentionalPartial<SourceData>,
-  ): void;
-
-  /** Create the polygon shape (or shapes) for this source using configured data. */
-  protected abstract _createShapes(): void;
-
-  /**
-   * Subclass specific configuration steps. Occurs after data initialization and shape computation.
-   * Only called if the source is attached and not disabled.
-   * @param changes - Changes to the source data which were applied
-   * @remarks Not actually abstract, but is a no-op in `BaseEffectSource`
-   * @privateRemarks This is actually passed *flattened* partial data, and while we were very close to having
-   * that be a non-issue, `RenderedEffectSource`'s data's `animation` and `GlobalLightSource`'s `darkness`
-   * properties are objects, so this can't just be `IntentionalPartial<SourceData>` until we have a `Flatten<>`
-   * type.
-   */
-  // TODO: Flatten<IntentionalPartial<SourceData>>
-  protected _configure(changes: AnyObject): void;
-
-  /**
-   * Refresh the state and uniforms of the source.
-   * Only active sources are refreshed.
-   */
-  refresh(): void;
-
-  /**
-   * Subclass-specific refresh steps.
-   */
-  protected _refresh(): void;
-
-  /**
-   * Steps that must be performed when the source is destroyed.
-   */
-  destroy(): void;
-
-  /**
-   * Subclass specific destruction steps.
-   */
-  protected _destroy(): void;
-
-  /**
-   * Add this BaseEffectSource instance to the active collection.
-   */
-  add(): void;
-
-  /**
-   * Remove this BaseEffectSource instance from the active collection.
-   */
-  remove(): void;
-
-  /**
-   * @deprecated since v11, will be removed in v13
-   * @remarks `"BaseEffectSource#sourceType is deprecated. Use BaseEffectSource.sourceType instead."`
-   */
-  get sourceType(): string;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"BaseEffectSource#_createShape is deprecated in favor of BaseEffectSource#_createShapes."`
-   */
-  protected _createShape(): void;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"BaseEffectSource#disabled is deprecated in favor of BaseEffectSource#data#disabled or BaseEffectSource#active depending on your use case."`
-   */
-  get disabled(): boolean;
-}
-
-declare namespace BaseEffectSource {
-  interface Any extends AnyBaseEffectSource {}
-  interface AnyConstructor extends Identity<typeof AnyBaseEffectSource> {}
-
-  /** @internal */
-  type _ConstructorOptions = NullishProps<{
-    /**
-     * An optional PlaceableObject which is responsible for this source
-     * @remarks Only the global light source is passed the ECG
-     */
-    object: PlaceableObject.Any | EffectsCanvasGroup.Any;
-  }>;
-
-  interface ConstructorOptions extends _ConstructorOptions {
-    /**
-     * A unique ID for this source. This will be set automatically if an
-     * object is provided, otherwise is required.
-     * @remarks The above is misleading; sourceId will only be inferred if you pass a `PlaceableObject`
-     * _instead_ of an options object to the constructor (which is a deprecated path removed in v13),
-     * _not_ if you pass in `{ object: PlaceableObject }`, where you're expected to also pass `sourceId`
-     * yourself.
-     */
-    sourceId?: string;
-  }
-
-  interface SourceData {
-    /**
-     * The x-coordinate of the source location
-     * @defaultValue `0`
-     */
-    x: number;
-
-    /**
-     * The y-coordinate of the source location
-     * @defaultValue `0`
-     */
-    y: number;
-
-    /**
-     * The elevation of the point source
-     * @defaultValue `0`
-     */
-    elevation: number;
-
-    /**
-     * Whether or not the source is disabled
-     * @defaultValue `false`
-     */
-    disabled: boolean;
-  }
-
-  /** @internal */
-  type _InitializeOptions = NullishProps<{
-    /**
-     * Should source data be reset to default values before applying changes?
-     * @defaultValue `false`
-     */
-    reset: boolean;
-  }>;
-
-  /** @privateRemarks Foundry describes an `options.behaviors` key, but it is neither checked for nor used at runtime */
-  interface InitializeOptions extends _InitializeOptions {}
-
-  /** @privateRemarks The `| number` is from Foundry's typing, but core only uses boolean flags in v12.331 */
-  interface Flags extends Record<string, boolean | number | undefined> {
-    renderSoftEdges?: boolean;
-    initializedMeshes?: boolean;
-    hasColor?: boolean;
-  }
-}
-
-declare abstract class AnyBaseEffectSource extends BaseEffectSource<BaseEffectSource.SourceData, PIXI.Polygon> {
-  constructor(...args: never);
-}
-
-export default BaseEffectSource;

package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts

@@ -1,223 +0,0 @@
-import type { Identity, IntentionalPartial, NullishProps } from "fvtt-types/utils";
-import type RenderedEffectSource from "./rendered-effect-source.d.mts";
-
-/**
- * A specialized subclass of BaseEffectSource which deals with the rendering of light or darkness.
- */
-declare abstract class BaseLightSource<
-  SourceData extends BaseLightSource.SourceData = BaseLightSource.SourceData,
-  SourceShape extends PIXI.Polygon = PIXI.Polygon,
-  RenderingLayers extends Record<string, RenderedEffectSource.SourceLayer> = RenderedEffectSource.Layers,
-> extends RenderedEffectSource<SourceData, SourceShape, RenderingLayers> {
-  /** @defaultValue `"light"` */
-  static override sourceType: string;
-
-  /** @defaultValue `["animation.type", "walls"]` */
-  protected static override _initializeShaderKeys: string[];
-
-  /** @defaultValue `["dim", "bright", "attenuation", "alpha", "coloration", "color", "contrast", "saturation", "shadows", "luminosity"]` */
-  protected static override _refreshUniformsKeys: string[];
-
-  /**
-   * The corresponding lighting levels for dim light.
-   * @defaultValue `foundry.CONST.LIGHTING_LEVELS.DIM`
-   */
-  protected static _dimLightingLevel: foundry.CONST.LIGHTING_LEVELS;
-
-  /**
-   * The corresponding lighting levels for bright light.
-   * @defaultValue `foundry.CONST.LIGHTING_LEVELS.BRIGHT`
-   */
-  protected static _brightLightingLevel: foundry.CONST.LIGHTING_LEVELS;
-
-  /**
-   * The corresponding animation config.
-   * @privateRemarks Only uses {@link CONFIG.Canvas.lightAnimations | `CONFIG.Canvas.lightAnimations`} in
-   * {@link foundry.canvas.sources.BaseLightSource | `foundry.canvas.sources.BaseLightSource`}, but
-   * {@link foundry.canvas.sources.PointDarknessSource | `foundry.canvas.sources.PointDarknessSource`}
-   * overrides to use `.darknessAnimations`, so the union type is necessary
-   */
-  protected static get ANIMATIONS(): typeof CONFIG.Canvas.lightAnimations | typeof CONFIG.Canvas.darknessAnimations;
-
-  /**
-   * @defaultValue
-   * ```js
-   * {
-   *   ...super.defaultData,
-   *   priority: 0,
-   *   alpha: 0.5,
-   *   bright: 0,
-   *   coloration: 1,
-   *   contrast: 0,
-   *   dim: 0,
-   *   attenuation: 0.5,
-   *   luminosity: 0.5,
-   *   saturation: 0,
-   *   shadows: 0,
-   *   vision: false
-   * }
-   * ```
-   */
-  static override defaultData: BaseLightSource.SourceData;
-
-  /**
-   * A ratio of dim:bright as part of the source radius
-   */
-  ratio: number;
-
-  protected override _initialize(data: IntentionalPartial<SourceData>): void;
-
-  protected override _updateColorationUniforms(): void;
-
-  protected override _updateIlluminationUniforms(): void;
-
-  protected override _updateBackgroundUniforms(): void;
-
-  protected override _updateCommonUniforms(shader: AbstractBaseShader): void;
-
-  /** @remarks Doesn't exist prior to initialization. Ultimately set in `_updateCommonUniforms` */
-  cachedAttenuation?: number;
-
-  /** @remarks Doesn't exist prior to initialization. Ultimately set in `_updateCommonUniforms` */
-  computedAttenuation?: number;
-
-  /**
-   * An animation with flickering ratio and light intensity.
-   * @param dt      - Delta time
-   * @param options - Additional options which modify the torch animation
-   */
-  // not null (destructured)
-  animateTorch(dt: number, options?: RenderedEffectSource.AnimationFunctionOptions): void;
-
-  /**
-   * An animation with flickering ratio and light intensity
-   * @param dt      - Delta time
-   * @param options - Additional options which modify the flame animation
-   */
-  // not null (destructured)
-  animateFlickering(dt: number, options?: BaseLightSource.AnimateFlickeringOptions): void;
-
-  /**
-   * @remarks This property will be generated on any class that is `#animateFlickering`'s `this` when it is called.
-   * In Foundry practice this will always be a `BaseLightSource` subclass, so it's defined here. Foundry does not
-   * document it.
-   */
-  _noise?: SmoothNoise;
-
-  /**
-   * A basic "pulse" animation which expands and contracts.
-   * @param dt      - Delta time
-   * @param options - Additional options which modify the pulse animation
-   */
-  // not null (destructured)
-  animatePulse(dt: number, options?: RenderedEffectSource.AnimationFunctionOptions): void;
-
-  /**
-   * @deprecated since v12, until v14
-   * @remarks "BaseLightSource#isDarkness is now obsolete. Use DarknessSource instead."
-   *
-   * Always returns `false`
-   */
-  get isDarkness(): boolean;
-}
-
-declare namespace BaseLightSource {
-  interface Any extends AnyBaseLightSource {}
-  interface AnyConstructor extends Identity<typeof AnyBaseLightSource> {}
-
-  type LightAnimationFunction = (
-    this: BaseLightSource,
-    dt: number,
-    options?: RenderedEffectSource.AnimationFunctionOptions,
-  ) => void;
-
-  interface SourceData extends RenderedEffectSource.SourceData {
-    /**
-     * An opacity for the emitted light, if any
-     * @defaultValue `0.5`
-     */
-    alpha: number;
-
-    /**
-     * The allowed radius of bright vision or illumination
-     * @defaultValue `0`
-     */
-    bright: number;
-
-    /**
-     * The coloration technique applied in the shader
-     * @defaultValue `1`
-     */
-    coloration: number;
-
-    /**
-     * The amount of contrast this light applies to the background texture
-     * @defaultValue `0`
-     */
-    contrast: number;
-
-    /**
-     * The allowed radius of dim vision or illumination
-     * @defaultValue `0`
-     */
-    dim: number;
-
-    /**
-     * Strength of the attenuation between bright, dim, and dark
-     * @defaultValue `0.5`
-     */
-    attenuation: number;
-
-    /**
-     * The luminosity applied in the shader
-     * @defaultValue `0.5`
-     */
-    luminosity: number;
-
-    /**
-     * The amount of color saturation this light applies to the background texture
-     * @defaultValue `0`
-     */
-    saturation: number;
-
-    /**
-     * The depth of shadows this light applies to the background texture
-     * @defaultValue `0`
-     */
-    shadows: number;
-
-    /**
-     * Whether or not this source provides a source of vision
-     * @defaultValue `false`
-     */
-    vision: boolean;
-
-    /**
-     * Strength of this source to beat or not negative/positive sources
-     * @defaultValue `0`
-     */
-    priority: number;
-  }
-
-  /** @internal */
-  type _AnimateFlickeringOptions = NullishProps<{
-    /**
-     * Noise amplification (\>1) or dampening (\<1)
-     * @defaultValue `1`
-     * @remarks Parameter default only, `null` is only cast to `0`
-     */
-    amplification: number;
-  }>;
-
-  interface AnimateFlickeringOptions extends RenderedEffectSource.AnimationFunctionOptions, _AnimateFlickeringOptions {}
-}
-
-declare abstract class AnyBaseLightSource extends BaseLightSource<
-  BaseLightSource.SourceData,
-  PIXI.Polygon,
-  RenderedEffectSource.Layers
-> {
-  constructor(...args: never);
-}
-
-export default BaseLightSource;

package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts

@@ -1,121 +0,0 @@
-import type { FixedInstanceType, Identity } from "fvtt-types/utils";
-import type BaseLightSource from "./base-light-source.d.mts";
-import type RenderedEffectSource from "./rendered-effect-source.d.mts";
-
-/**
- * A specialized subclass of the BaseLightSource which is used to render global light source linked to the scene.
- */
-declare class GlobalLightSource<
-  SourceData extends GlobalLightSource.SourceData = GlobalLightSource.SourceData,
-  SourceShape extends PIXI.Polygon = PIXI.Polygon,
-  RenderingLayers extends Record<string, RenderedEffectSource.SourceLayer> = RenderedEffectSource.Layers,
-> extends BaseLightSource<SourceData, SourceShape, RenderingLayers> {
-  /** @defaultValue `"GlobalLight"` */
-  static override sourceType: string;
-
-  /** @defaultValue `"lightSources"` */
-  static override effectsCollection: string;
-
-  /**
-   * @defaultValue
-   * ```js
-   * {
-   *   ...super.defaultData,
-   *   rotation: 0,
-   *   angle: 360,
-   *   attenuation: 0,
-   *   priority: -Infinity,
-   *   vision: false,
-   *   walls: false,
-   *   elevation: Infinity,
-   *   darkness: {min: 0, max: 0}
-   * }
-   * ```
-   */
-  static override defaultData: GlobalLightSource.SourceData;
-
-  /** @privateRemarks This class implements `#_createShapes`, so it's shape property will 'never' be undefined (after initialization) */
-  shape: SourceShape;
-
-  /**
-   * Name of this global light source.
-   * @defaultValue `this.constructor.sourceType` (`"GlobalLight"`)
-   */
-  name: string;
-
-  /**
-   * A custom polygon placeholder.
-   * @defaultValue `null`
-   * @remarks This is not set anywhere in Foundry code, so will always be null barring system/module/user action
-   */
-  customPolygon: PIXI.Polygon | number[] | null;
-
-  protected override _createShapes(): void;
-
-  protected override _initializeSoftEdges(): void;
-
-  protected override _updateGeometry(): void;
-
-  protected override _updateCommonUniforms(shader: AbstractBaseShader): void;
-}
-
-declare namespace GlobalLightSource {
-  interface Any extends AnyGlobalLightSource {}
-  interface AnyConstructor extends Identity<typeof AnyGlobalLightSource> {}
-
-  /**
-   * @privateRemarks `attenuation`, `priority`, and `elevation` exist in the parent interface,
-   * but are here for defaultValue overrides
-   */
-  interface SourceData extends BaseLightSource.SourceData {
-    /** @privateRemarks Type override only, the global light is not going to use a `darknessShader` */
-    animation: RenderedEffectSource.StoredLightAnimationConfig;
-
-    /**
-     * @defaultValue `0`
-     * @remarks Seemingly unused here, since `GlobalLightSource` does not inherit from `PointEffectSourceMixin`
-     */
-    rotation: number;
-
-    /**
-     * @defaultValue `360`
-     * @remarks Seemingly unused here, since `GlobalLightSource` does not inherit from `PointEffectSourceMixin`
-     */
-    angle: number;
-
-    /** @defaultValue `0` */
-    attenuation: number;
-
-    /** @defaultValue `-Infinity` */
-    priority: number;
-
-    // `vision` override omitted as it doesn't change the default
-
-    /**
-     * @defaultValue `false`
-     * @remarks Seemingly unused here, since `GlobalLightSource` does not inherit from `PointEffectSourceMixin`
-     */
-    walls: boolean;
-
-    /** @defaultValue `Infinity` */
-    elevation: number;
-
-    /** @remarks Threshold values for what darkness level the global light should be enabled for */
-    darkness: {
-      /** @defaultValue `0` */
-      min: number;
-
-      /** @defaultValue `0` */
-      max: number;
-    };
-  }
-
-  type ConfiguredClass = CONFIG["Canvas"]["globalLightSourceClass"];
-  type ConfiguredInstance = FixedInstanceType<ConfiguredClass>;
-}
-
-declare abstract class AnyGlobalLightSource extends GlobalLightSource {
-  constructor(...args: never);
-}
-
-export default GlobalLightSource;