@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/pixi/groups/effects.d.mts

@@ -1,237 +0,0 @@
-import type { HandleEmptyObject, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A container group which contains visual effects rendered above the primary group.
-   *
-   * TODO:
-   *  The effects canvas group is now only performing shape initialization, logic that needs to happen at
-   *  the placeable or object level is now their burden.
-   *  - [DONE] Adding or removing a source from the EffectsCanvasGroup collection.
-   *  - [TODO] A change in a darkness source should re-initialize all overlaping light and vision source.
-   *
-   * ### Hook Events
-   * - {@link hookEvents.lightingRefresh}
-   */
-  class EffectsCanvasGroup<
-    DrawOptions extends EffectsCanvasGroup.DrawOptions = EffectsCanvasGroup.DrawOptions,
-    TearDownOptions extends EffectsCanvasGroup.TearDownOptions = EffectsCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin(PIXI.Container)<DrawOptions, TearDownOptions> {
-    /**
-     * Whether to currently animate light sources.
-     * @defaultValue `true`
-     */
-    animateLightSources: boolean;
-
-    /**
-     * Whether to currently animate vision sources.
-     * @defaultValue `true`
-     */
-    animateVisionSources: boolean;
-
-    /**
-     * A mapping of light sources which are active within the rendered Scene.
-     */
-    lightSources: Collection<foundry.canvas.sources.PointLightSource>;
-
-    /**
-     * A mapping of darkness sources which are active within the rendered Scene.
-     */
-    darknessSources: Collection<foundry.canvas.sources.PointDarknessSource>;
-
-    /**
-     * A Collection of vision sources which are currently active within the rendered Scene.
-     */
-    visionSources: Collection<foundry.canvas.sources.PointVisionSource.Any>;
-
-    /**
-     * A set of vision mask filters used in visual effects group
-     */
-    visualEffectsMaskingFilters: Set<VisualEffectsMaskingFilter>;
-
-    /**
-     * Iterator for all light and darkness sources.
-     */
-    allSources(): Generator<
-      foundry.canvas.sources.PointDarknessSource | foundry.canvas.sources.PointLightSource,
-      void,
-      void
-    >;
-
-    override _createLayers(): Record<string, CanvasLayer>;
-
-    /**
-     * A layer of background alteration effects which change the appearance of the primary group render texture.
-     */
-    background: CanvasBackgroundAlterationEffects;
-
-    /**
-     * A layer which adds illumination-based effects to the scene.
-     */
-    illumination: CanvasIlluminationEffects;
-
-    /**
-     * A layer which adds color-based effects to the scene.
-     */
-    coloration: CanvasColorationEffects;
-
-    /**
-     * A layer which adds darkness effects to the scene.
-     */
-    darkness: CanvasDarknessEffects;
-
-    /**
-     * Clear all effects containers and animated sources.
-     */
-    clearEffects(): void;
-
-    protected override _draw(options: HandleEmptyObject<DrawOptions>): Promise<void>;
-
-    /**
-     * Initialize positive light sources which exist within the active Scene.
-     * Packages can use the "initializeLightSources" hook to programmatically add light sources.
-     */
-    initializeLightSources(): void;
-
-    /**
-     * Re-initialize the shapes of all darkness sources in the Scene.
-     * This happens before initialization of light sources because darkness sources contribute additional edges which
-     * limit perception.
-     * Packages can use the "initializeDarknessSources" hook to programmatically add darkness sources.
-     */
-    initializeDarknessSources(): void;
-
-    /**
-     * Refresh the state and uniforms of all light sources and darkness sources objects.
-     */
-    refreshLightSources(): void;
-
-    /**
-     * Refresh the state and uniforms of all VisionSource objects.
-     */
-    refreshVisionSources(): void;
-
-    /**
-     * Refresh the active display of lighting.
-     */
-    refreshLighting(): void;
-
-    /**
-     * Test whether the point is inside light.
-     * @param point     - The point.
-     * @param elevation - The elevation of the point.
-     * @returns Is inside light?
-     */
-    testInsideLight(point: Canvas.Point, elevation: number): boolean;
-
-    /**
-     * Test whether the point is inside darkness.
-     * @param point     - The point.
-     * @param elevation - The elevation of the point.
-     * @returns Is inside darkness?
-     * @remarks Foundry does not use the `elevation` parameter
-     */
-    testInsideDarkness(point: Canvas.Point, _elevation?: number): boolean;
-
-    /**
-     * Get the darkness level at the given point.
-     * @param point     - The point.
-     * @param elevation - The elevation of the point.
-     * @returns The darkness level.
-     */
-    getDarknessLevel(point: Canvas.Point, elevation: number): number;
-
-    override _tearDown(options: HandleEmptyObject<TearDownOptions>): Promise<void>;
-
-    /**
-     * Activate vision masking for visual effects
-     * @param enabled - Whether to enable or disable vision masking
-     *                  (default: `true`)
-     */
-    toggleMaskingFilters(enabled?: boolean): void;
-
-    /**
-     * Activate post-processing effects for a certain effects channel.
-     * @param filterMode          - The filter mode to target.
-     * @param postProcessingModes - The post-processing modes to apply to this filter.
-     * @param uniforms            - The uniforms to update.
-     */
-    activatePostProcessingFilters(
-      filterMode: VisualEffectsMaskingFilter.FILTER_MODES,
-      postProcessingModes?: VisualEffectsMaskingFilter.PostProcessModes,
-      uniforms?: AbstractBaseShader.Uniforms,
-    ): void;
-
-    /**
-     * Reset post-processing modes on all Visual Effects masking filters.
-     */
-    resetPostProcessingFilters(): void;
-
-    /**
-     * Activate light source animation for AmbientLight objects within this layer
-     */
-    activateAnimation(): void;
-
-    /**
-     * Deactivate light source animation for AmbientLight objects within this layer
-     */
-    deactivateAnimation(): void;
-
-    /**
-     * Animate a smooth transition of the darkness overlay to a target value.
-     * Only begin animating if another animation is not already in progress.
-     * @param target - The target darkness level between 0 and 1
-     * @returns A Promise which resolves once the animation is complete
-     */
-    animateDarkness(
-      target?: number,
-      options?: EffectsCanvasGroup.AnimateDarknessOptions,
-    ): CanvasAnimation.AnimateReturn;
-
-    /**
-     * @deprecated since v12, until v14
-     * @remarks "EffectsCanvasGroup#visibility has been deprecated and moved to Canvas#visibility."
-     */
-    get visibility(): Canvas["visibility"];
-
-    /**
-     * @deprecated since v12, until v14
-     * @remarks "EffectsCanvasGroup#globalLightSource has been deprecated and moved to EnvironmentCanvasGroup#globalLightSource."
-     */
-    get globalLightSource(): Canvas["environment"]["globalLightSource"];
-
-    /**
-     * @deprecated since v12
-     * @remarks "EffectsCanvasGroup#updateGlobalLightSource has been deprecated and is part of EnvironmentCanvasGroup#initialize workflow."
-     */
-    updateGlobalLightSource(): void;
-  }
-
-  namespace EffectsCanvasGroup {
-    interface Any extends AnyEffectsCanvasGroup {}
-    type AnyConstructor = typeof AnyEffectsCanvasGroup;
-
-    /** @internal */
-    type _AnimateDarknessOptions = NullishProps<{
-      /**
-       * The desired animation time in milliseconds. Default is 10 seconds
-       * @defaultValue `10000`
-       * @remarks Only has a parameter default; `null` is effectively `0`, resulting in no animation, just instant darkness
-       */
-      duration: number;
-    }>;
-
-    interface AnimateDarknessOptions extends _AnimateDarknessOptions {}
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyEffectsCanvasGroup extends EffectsCanvasGroup<
-  EffectsCanvasGroup.DrawOptions,
-  EffectsCanvasGroup.TearDownOptions
-> {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/groups/environment.d.mts

@@ -1,129 +0,0 @@
-import type { FixedInstanceType, HandleEmptyObject, InexactPartial, NullishProps } from "fvtt-types/utils";
-import type { SceneEnvironmentData } from "../../../common/documents/_types.d.mts";
-
-declare global {
-  /**
-   * A container group which contains the primary canvas group and the effects canvas group.
-   */
-  class EnvironmentCanvasGroup<
-    DrawOptions extends EnvironmentCanvasGroup.DrawOptions = EnvironmentCanvasGroup.DrawOptions,
-    TearDownOptions extends EnvironmentCanvasGroup.TearDownOptions = EnvironmentCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof PIXI.Container, "environment">(PIXI.Container)<DrawOptions, TearDownOptions> {
-    /**
-     * The global light source attached to the environment
-     * @remarks This is `defineProperty`'d as non-writable and non-configurable at construction
-     */
-    readonly globalLightSource: FixedInstanceType<typeof CONFIG.Canvas.globalLightSourceClass>;
-
-    /**
-     * Should this group tear down its non-layer children?
-     * @defaultValue `false`
-     */
-    static override tearDownChildren: boolean;
-
-    /**
-     * Colors exposed by the manager.
-     * @remarks Properties here are only `undefined` prior to `#initialize`ation
-     */
-    colors: EnvironmentCanvasGroup.Colors;
-
-    /**
-     * Weights used by the manager to compute colors.
-     * @remarks Properties here are only `undefined` prior to `#initialize`ation
-     */
-    weights: EnvironmentCanvasGroup.Weights;
-
-    /**
-     * Get the darkness level of this scene.
-     */
-    get darknessLevel(): number;
-
-    protected override _draw(options: HandleEmptyObject<DrawOptions>): Promise<void>;
-
-    /**
-     * Initialize the scene environment options.
-     * @remarks `@fires PIXI.FederatedEvent type: "darknessChange" - event: {environmentData: {darknessLevel, priorDarknessLevel}}`
-     */
-    initialize(config?: EnvironmentCanvasGroup.InitializeOptions): void;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks `"EnvironmentCanvasGroup#darknessPenalty is deprecated without replacement. The darkness penalty is no longer applied on light and vision sources."`
-     */
-    get darknessPenalty(): 0;
-  }
-
-  namespace EnvironmentCanvasGroup {
-    interface Any extends AnyEnvironmentCanvasGroup {}
-    type AnyConstructor = typeof AnyEnvironmentCanvasGroup;
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-
-    type ColorKeys =
-      | "darkness"
-      | "halfdark"
-      | "background"
-      | "dim"
-      | "bright"
-      | "ambientBrightest"
-      | "ambientDaylight"
-      | "ambientDarkness"
-      | "sceneBackground"
-      | "fogExplored"
-      | "fogUnexplored";
-
-    interface Colors extends Record<EnvironmentCanvasGroup.ColorKeys, Color | undefined> {}
-
-    type WeightKeys = "dark" | "halfdark" | "dim" | "bright";
-
-    interface Weights extends Record<EnvironmentCanvasGroup.WeightKeys, number | undefined> {}
-
-    /** @internal */
-    type _InitializeOptions = NullishProps<{
-      /** The background canvas color */
-      backgroundColor: Color.Source;
-
-      /** The brightest ambient color */
-      brightestColor: Color.Source;
-
-      /** The color of darkness */
-      darknessColor: Color.Source;
-
-      /** The ambient daylight color */
-      daylightColor: Color.Source;
-
-      /** The color applied to explored areas */
-      fogExploredColor: Color.Source;
-
-      /** The color applied to unexplored areas */
-      fogUnexploredColor: Color.Source;
-
-      /**
-       * @deprecated since v12 until v14
-       * @remarks "config.darknessLevel parameter into EnvironmentCanvasGroup#initialize is deprecated.
-       * You should pass the darkness level into config.environment.darknessLevel"
-       * @privateRemarks [sic]
-       */
-      darknessLevel: number;
-    }> &
-      InexactPartial<{
-        /**
-         * The scene environment data
-         * @defaultValue `{}`
-         * @remarks Can't be `null` as it only has a parameter default and has properties accessed
-         */
-        environment: NullishProps<SceneEnvironmentData>;
-      }>;
-
-    interface InitializeOptions extends _InitializeOptions {}
-  }
-}
-
-declare abstract class AnyEnvironmentCanvasGroup extends EnvironmentCanvasGroup<
-  EnvironmentCanvasGroup.DrawOptions,
-  EnvironmentCanvasGroup.TearDownOptions
-> {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/groups/hidden.d.mts

@@ -1,56 +0,0 @@
-import type { HandleEmptyObject } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A specialized canvas group for rendering hidden containers before all others (like masks).
-   */
-  class HiddenCanvasGroup<
-    DrawOptions extends HiddenCanvasGroup.DrawOptions = HiddenCanvasGroup.DrawOptions,
-    TearDownOptions extends HiddenCanvasGroup.TearDownOptions = HiddenCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof PIXI.Container, "hidden">(PIXI.Container)<DrawOptions, TearDownOptions> {
-    /**
-     * @defaultValue `"none"`
-     */
-    override eventMode: PIXI.EventMode;
-
-    /**
-     * The container which hold masks.
-     */
-    masks: PIXI.Container;
-
-    /**
-     * Add a mask to this group.
-     * @param name          - Name of the mask.
-     * @param displayObject - Display object to add.
-     * @param position      - Position of the mask.
-     * @throws If `displayObject` doesn't implement a `clear` method, or if `name` is an empty string
-     * @remarks `position` is not used if fasley
-     */
-    addMask(name: string, displayObject: PIXI.DisplayObject, position?: number | null): void;
-
-    /**
-     * Invalidate the masks: flag them for rerendering.
-     */
-    invalidateMasks(): void;
-
-    protected override _draw(options: HandleEmptyObject<DrawOptions>): Promise<void>;
-
-    protected override _tearDown(options: HandleEmptyObject<TearDownOptions>): Promise<void>;
-  }
-
-  namespace HiddenCanvasGroup {
-    interface Any extends AnyHiddenCanvasGroup {}
-    type AnyConstructor = typeof AnyHiddenCanvasGroup;
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyHiddenCanvasGroup extends HiddenCanvasGroup<
-  HiddenCanvasGroup.DrawOptions,
-  HiddenCanvasGroup.TearDownOptions
-> {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/groups/index.d.mts

@@ -1,7 +0,0 @@
-import "./effects.d.mts";
-import "./environment.d.mts";
-import "./hidden.d.mts";
-import "./interface.d.mts";
-import "./overlay.d.mts";
-import "./primary.d.mts";
-import "./rendered.d.mts";

package/src/foundry/client/pixi/groups/interface.d.mts

@@ -1,98 +0,0 @@
-import type { HandleEmptyObject, InexactPartial, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A container group which displays interface elements rendered above other canvas groups.
-   */
-  class InterfaceCanvasGroup<
-    DrawOptions extends InterfaceCanvasGroup.DrawOptions = InterfaceCanvasGroup.DrawOptions,
-    TearDownOptions extends InterfaceCanvasGroup.TearDownOptions = InterfaceCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof PIXI.Container, "interface">(PIXI.Container)<DrawOptions, TearDownOptions> {
-    /**
-     * Add a PrimaryGraphics to the group.
-     * @param drawing - The Drawing being added
-     * @returns The created Graphics instance
-     * @remarks
-     */
-    addDrawing(drawing: Drawing.ConfiguredInstance): PIXI.Graphics;
-
-    /**
-     * Remove a PrimaryGraphics from the group.
-     * @param drawing - The Drawing being removed
-     */
-    removeDrawing(drawing: Drawing.ConfiguredInstance): void;
-
-    protected override _draw(options: HandleEmptyObject<DrawOptions>): Promise<void>;
-
-    /**
-     * Display scrolling status text originating from this ObjectHUD container.
-     * @param origin  - An origin point where the text should first emerge
-     * @param content - The text content to display
-     * @param options - Options which customize the text animation
-     * @returns - The created PreciseText object which is scrolling
-     * @remarks Only returns `null` if the core `scrollingStatusText` setting is falsey
-     */
-    createScrollingText(
-      origin: Canvas.Point,
-      content: string,
-      options?: InterfaceCanvasGroup.CreateScrollingTextOptions,
-    ): Promise<PreciseText | null>;
-  }
-
-  namespace InterfaceCanvasGroup {
-    interface Any extends AnyInterfaceCanvasGroup {}
-    type AnyConstructor = typeof AnyInterfaceCanvasGroup;
-
-    /** @internal */
-    type _CreateScrollingTextOptions = NullishProps<{
-      /**
-       * The distance in pixels that the scrolling text should travel
-       * @defaultValue Double the width or height of the text, depending on direction
-       * @remarks Default provided by `??`
-       */
-      distance: number;
-
-      /**
-       * The original anchor point where the text appears
-       * @defaultValue `CONST.TEXT_ANCHOR_POINTS.CENTER`
-       */
-      anchor: foundry.CONST.TEXT_ANCHOR_POINTS;
-
-      /**
-       * The direction in which the text scrolls
-       * @defaultValue `CONST.TEXT_ANCHOR_POINTS.TOP`
-       */
-      direction: foundry.CONST.TEXT_ANCHOR_POINTS;
-
-      /**
-       * An amount of randomization between [0, 1] applied to the initial position
-       * @defaultValue `0`
-       * @remarks Only used if truthy
-       */
-      jitter: number;
-    }> &
-      InexactPartial<{
-        /**
-         * The duration of the scrolling effect in milliseconds
-         * @defaultValue `2000`
-         * @remarks Can't be `null` as it only has a parameter default and a duration of `0` is not appropriate
-         */
-        duration: number;
-      }> &
-      /**
-       * Additional parameters of PIXI.TextStyle which are applied to the text
-       * @remarks Excess keys are collected as `{...textStyle}` and passed to {@link PreciseText.getTextStyle} which checks for `!== undefined`, so this can't be NullishProps
-       */
-      InexactPartial<PIXI.ITextStyle>;
-
-    interface CreateScrollingTextOptions extends _CreateScrollingTextOptions {}
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyInterfaceCanvasGroup extends InterfaceCanvasGroup {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/groups/overlay.d.mts

@@ -1,30 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A container group which is not bound to the stage world transform.
-   */
-  class OverlayCanvasGroup<
-    DrawOptions extends OverlayCanvasGroup.DrawOptions = OverlayCanvasGroup.DrawOptions,
-    TearDownOptions extends OverlayCanvasGroup.TearDownOptions = OverlayCanvasGroup.TearDownOptions,
-  > extends CanvasGroupMixin<typeof UnboundContainer, "overlay">(UnboundContainer)<DrawOptions, TearDownOptions> {
-    /**
-     * Should this group tear down its non-layer children?
-     * @defaultValue `false`
-     */
-    static override tearDownChildren: boolean;
-  }
-
-  namespace OverlayCanvasGroup {
-    interface Any extends AnyOverlayCanvasGroup {}
-    type AnyConstructor = typeof AnyOverlayCanvasGroup;
-
-    interface DrawOptions extends CanvasGroupMixin.DrawOptions {}
-
-    interface TearDownOptions extends CanvasGroupMixin.TearDownOptions {}
-  }
-}
-
-declare abstract class AnyOverlayCanvasGroup extends OverlayCanvasGroup {
-  constructor(arg0: never, ...args: never[]);
-}