@league-of-foundry-developers/foundry-vtt-types 12.331.1-beta → 12.331.3-beta

package/src/foundry/client/audio/sound.d.mts

@@ -1,307 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The Sound class is used to control the playback of audio sources using the Web Audio API.
-   */
-  class Sound {
-    constructor(src: string, options?: { container?: AudioContainer });
-
-    /**
-     * The numeric identifier for accessing this node
-     */
-    id: number;
-
-    /**
-     * The audio source path
-     */
-    src: string;
-
-    /**
-     * The AudioContainer which controls playback
-     */
-    container: AudioContainer;
-
-    /**
-     * The time in seconds at which playback was started
-     * @defaultValue `undefined`
-     */
-    startTime: number | undefined;
-
-    /**
-     * The time in seconds at which playback was paused
-     * @defaultValue `undefined`
-     */
-    pausedTime: number | undefined;
-
-    /**
-     * Registered event callbacks
-     * @defaultValue `{stop: {}, start: {}, end: {}, pause: {}, load: {}}`
-     */
-    events: Sound.EventCallbacks;
-
-    /**
-     * The registered event handler id for this Sound.
-     * Incremented each time a callback is registered.
-     * @defaultValue `1`
-     * @internal
-     */
-    protected _eventHandlerId: number;
-
-    /**
-     * If this Sound source is currently in the process of loading, this attribute contains a Promise that will resolve
-     * when the loading process completes.
-     * @defaultValue `undefined`
-     */
-    loading: Promise<void> | undefined;
-
-    /**
-     * A collection of scheduled events recorded as window timeout IDs
-     * @internal
-     */
-    protected _scheduledEvents: Set<number>;
-
-    /**
-     * A global audio node ID used to quickly reference a specific audio node
-     * @defaultValue `0`
-     * @internal
-     */
-    protected static _nodeId: number;
-
-    /**
-     * A convenience reference to the sound context used by the application
-     */
-    get context(): AudioContext;
-
-    /**
-     * A reference to the audio source node being used by the AudioContainer
-     */
-    get node(): AudioBufferSourceNode | MediaElementAudioSourceNode | undefined;
-
-    /**
-     * A reference to the GainNode parameter which controls volume
-     */
-    get gain(): AudioParam | undefined;
-
-    /**
-     * The current playback time of the sound
-     */
-    get currentTime(): number | undefined;
-
-    /**
-     * The total sound duration, in seconds
-     */
-    get duration(): number | undefined;
-
-    /**
-     * Is the contained audio node loaded and ready for playback?
-     */
-    get loaded(): boolean;
-
-    /**
-     * Did the contained audio node fail to load?
-     */
-    get failed(): boolean;
-
-    /**
-     * Is the audio source currently playing?
-     */
-    get playing(): boolean;
-
-    /**
-     * Is the Sound current looping?
-     */
-    get loop(): boolean;
-    set loop(looping: boolean);
-
-    /**
-     * The volume at which the Sound is playing
-     */
-    get volume(): number | undefined;
-    set volume(value: number | undefined);
-
-    /**
-     * Fade the volume for this sound between its current level and a desired target volume
-     * @param volume  - The desired target volume level between 0 and 1
-     * @param options - Additional options that configure the fade operation
-     *                  (default: `{}`)
-     * @returns A Promise that resolves after the requested fade duration
-     */
-    fade(volume: number, options?: Sound.FadeOptions): Promise<void>;
-
-    /**
-     * Load the audio source, creating an AudioBuffer.
-     * Audio loading is idempotent, it can be requested multiple times but only the first load request will be honored.
-     * @param options - Additional options which affect resource loading
-     *                  (default: `{}`)
-     * @returns The Sound once its source audio buffer is loaded
-     */
-    load(options?: Sound.LoadOptions): Promise<Sound>;
-
-    /**
-     * Begin playback for the sound node
-     * @param options - Options which configure playback
-     *                  (default: `{}`)
-     */
-    play(options?: Sound.PlayOptions): void;
-
-    /**
-     * Pause playback, remembering the playback position in order to resume later.
-     */
-    pause(): void;
-
-    /**
-     * Stop playback, fully resetting the Sound to a non-playing state.
-     */
-    stop(): void;
-
-    /**
-     * Schedule a function to occur at the next occurrence of a specific playbackTime for this Sound.
-     * @param fn           - A function that will be called with this Sound as its single argument
-     * @param playbackTime - The desired playback time at which the function should be called
-     * @returns A Promise which resolves once the scheduled function has been called
-     *
-     * @example Schedule audio playback changes
-     * ```typescript
-     * sound.schedule(() => console.log("Do something exactly 30 seconds into the track"), 30);
-     * sound.schedule(() => console.log("Do something next time the track loops back to the beginning"), 0);
-     * sound.schedule(() => console.log("Do something 5 seconds before the end of the track"), sound.duration - 5);
-     * ```
-     */
-    schedule(fn: Sound.Callback, playbackTime: number): Promise<void>;
-
-    /**
-     * Trigger registered callback functions for a specific event name.
-     * @param eventName - The event name being emitted
-     */
-    emit(eventName: Sound.EventName): void;
-
-    /**
-     * Deactivate an event handler which was previously registered for a specific event
-     * @param eventName - The event name being deactivated
-     * @param fn        - The callback ID or callback function being un-registered
-     */
-    off(eventName: Sound.EventName, fn: number | Sound.Callback): void;
-
-    /**
-     * Register an event handler to take actions for a certain Sound event.
-     * @param eventName- The event name being deactivated
-     * @param fn       - The callback function to trigger when the event occurs
-     * @param options  - Additional options that affect callback registration
-     *                   (default: `{}`)
-     */
-    on(eventName: Sound.EventName, fn: Sound.Callback, options?: Sound.OnOptions): number;
-
-    /**
-     * Register a new callback function for a certain event. For internal use only.
-     * @internal
-     */
-    protected _registerForEvent(eventName: Sound.EventName, callback: Sound.Callback): number;
-
-    /**
-     * Cancel all pending scheduled events.
-     * @internal
-     */
-    protected _clearEvents(): void;
-
-    /**
-     * Called when playback concludes naturally
-     */
-    protected _onEnd(): void;
-
-    /**
-     * Called when the audio buffer is first loaded
-     */
-    protected _onLoad(): void;
-
-    /**
-     * Called when playback is paused
-     */
-    protected _onPause(): void;
-
-    /**
-     * Called when the sound begins playing
-     */
-    protected _onStart(): void;
-
-    /**
-     * Called when playback is stopped (prior to naturally reaching the end)
-     */
-    protected _onStop(): void;
-  }
-
-  namespace Sound {
-    type Callback = (sound: Sound) => void;
-
-    type EventName = "end" | "pause" | "start" | "stop" | "load";
-
-    type EventCallbacks = Record<EventName, Partial<Record<number, Callback>>>;
-
-    type FadeType = "linear" | "exponential";
-
-    interface FadeOptions {
-      /**
-       * The duration of the fade effect in milliseconds
-       * @defaultValue `1000`
-       */
-      duration?: number;
-
-      /**
-       * A volume level to start from, the current volume by default
-       */
-      from?: number;
-
-      /**
-       * The type of fade easing, "linear" or "exponential"
-       * @defaultValue `"linear"`
-       */
-      type?: FadeType;
-    }
-
-    interface LoadOptions {
-      /**
-       * Automatically begin playback of the audio source once loaded
-       * @defaultValue `false`
-       */
-      autoplay?: boolean;
-
-      /**
-       * Additional options passed to the play method when loading is complete
-       * @defaultValue `{}`
-       */
-      autoplayOptions?: PlayOptions;
-    }
-
-    interface PlayOptions {
-      /**
-       * Whether to loop the audio automatically
-       * @defaultValue `false`
-       */
-      loop?: boolean;
-
-      /**
-       * A specific offset in seconds at which to begin playback
-       */
-      offset?: number;
-
-      /**
-       * The desired volume at which to begin playback
-       */
-      volume?: number;
-
-      /**
-       * Fade volume changes over a desired duration in milliseconds
-       * @defaultValue `0`
-       */
-      fade?: number;
-    }
-
-    interface OnOptions {
-      /**
-       * Trigger the callback once only and automatically un-register it
-       * @defaultValue `false`
-       */
-      once?: boolean;
-    }
-  }
-}

package/src/foundry/client/pixi/core/shapes/polygon-helpers.d.mts

@@ -1,31 +0,0 @@
-import type Document from "../../../../common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * An internal data structure for polygon edges
-   * @internal
-   */
-  class PolygonEdge {
-    constructor(a: Point, b: Point, type: foundry.CONST.WALL_SENSE_TYPES, wall: Wall);
-
-    /**
-     * An internal flag used to record whether an Edge represents a canvas boundary.
-     */
-    protected _isBoundary: boolean;
-
-    /**
-     * Is this edge limited in type?
-     */
-    get isLimited(): boolean;
-
-    /**
-     * Construct a PolygonEdge instance from a Wall placeable object.
-     * @param wall - The Wall from which to construct an edge
-     * @param type - The type of polygon being constructed
-     */
-    static fromWall(
-      wall: Document.ConfiguredObjectClassForName<"Wall"> | WallDocument,
-      type: foundry.CONST.WALL_RESTRICTION_TYPES,
-    ): PolygonEdge;
-  }
-}

package/src/foundry/client/pixi/layers/controls/hud.d.mts

@@ -1,114 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * @deprecated since v10, will be removed in v12
-   * @remarks `"The SynchronizedTransform class is deprecated and should no longer be used."`
-   */
-  class SynchronizedTransform extends PIXI.Transform {
-    constructor(transform: PIXI.Transform);
-
-    /**
-     * A list of attributes from the transform reference which should be synchronized
-     * @defaultValue
-     * ```javascript
-     * [
-     *   "localTransform", "position", "scale", "pivot", "skew", "_rotation",
-     *   "_cx", "_sx", "_cy", "_sy", "_localID", "_currentLocalID"
-     * ];
-     * ```
-     */
-    static synchronizedAttributes: string[];
-
-    /**
-     * A Transform instance which defines the reference point for the worldTransform
-     */
-    get reference(): PIXI.Transform;
-
-    set reference(value: PIXI.Transform);
-
-    /** @internal */
-    protected _reference: PIXI.Transform;
-
-    /** @internal */
-    protected _syncLocalID: number;
-
-    override updateTransform(parentTransform: PIXI.Transform): void;
-
-    override updateLocalTransform(): void;
-  }
-
-  /**
-   * @deprecated since v10, will be removed in v12
-   * @remarks `"The ObjectHUD class is deprecated and should no longer be used."`
-   */
-  class ObjectHUD extends PIXI.Container {
-    constructor(object: PIXI.DisplayObject);
-
-    /**
-     * The object that this HUD container is linked to
-     */
-    object: PIXI.DisplayObject;
-
-    /**
-     * Use the linked object's transform matrix to easily synchronize position
-     */
-    transform: PIXI.Transform;
-
-    // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
-    override get visible(): boolean;
-    override set visible(value: boolean);
-
-    // @ts-expect-error this is a property in `PIXI.Container` but foundry overrides it as an accessor.
-    override get renderable(): boolean;
-    override set renderable(value: boolean);
-
-    /**
-     * @deprecated since v10, will be removed in v12
-     * @remarks `"You are calling ObjectHUD#createScrollingText which has been migrated and refactored to CanvasInterfaceGroup#createScrollingText"`
-     */
-    createScrollingText(content: string, options?: ObjectHUD.CreateScrollingTextOptions): Promise<PreciseText | null>;
-
-    /**
-     * Orchestrate the animation of the scrolling text in this HUD
-     * @param text     - The PrecisText instance to animate
-     * @param duration - A desired duration of animation
-     * @param dx       - A horizontal distance to animate the text
-     *                   (default: `0`)
-     * @param dy       - A vertical distance to animate the text
-     *                   (default: `0`)
-     * @internal
-     */
-    protected _animateScrollText(text: PreciseText, duration: number, dx?: number, dy?: number): Promise<void>;
-  }
-
-  type TextStyleProperties = Exclude<ConstructorParameters<typeof PIXI.TextStyle>[0], undefined>;
-
-  namespace ObjectHUD {
-    interface CreateScrollingTextOptions extends TextStyleProperties {
-      /**
-       * The original anchor point where the text first appears
-       * @defaultValue `CONST.TEXT_ANCHOR_POINTS.CENTER`
-       */
-      anchor?: foundry.CONST.TEXT_ANCHOR_POINTS | undefined;
-
-      /**
-       * The direction in which the text scrolls
-       * @defaultValue `CONST.TEXT_ANCHOR_POINTS.TOP`
-       */
-      direction?: foundry.CONST.TEXT_ANCHOR_POINTS | undefined;
-
-      /**
-       * The duration of the scrolling effect in milliseconds
-       * @defaultValue `2000`
-       */
-      duration?: number | undefined;
-
-      /**
-       * An amount of randomization between 0 and 1 to apply to the initial Position
-       * @defaultValue `0`
-       */
-      jitter?: number | undefined;
-    }
-  }
-}

package/src/foundry/client/pixi/perception/color-manager.d.mts

@@ -1,86 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A singleton class dedicated to manage the color spaces associated with the scene and the canvas.
-   */
-  class CanvasColorManager {
-    /**
-     * Colors exposed by the manager.
-     */
-    colors: {
-      darkness?: Color;
-      halfdark?: Color;
-      /** @defaultValue `0x909090` */
-      background?: Color;
-      dim?: Color;
-      bright?: Color;
-      ambientBrightest?: Color;
-      ambientDaylight?: Color;
-      ambientDarkness?: Color;
-      sceneBackground?: Color;
-      /** @defaultValue `0x000000` */
-      fogExplored?: Color;
-      /** @defaultValue `0x000000` */
-      fogUnexplored?: Color;
-    };
-
-    /**
-     * Weights used by the manager to compute colors.
-     */
-    weights: {
-      dark?: number;
-      halfdark?: number;
-      dim?: number;
-      bright?: number;
-    };
-
-    /**
-     * Fallback colors.
-     */
-    static #fallbackColors: {
-      darknessColor: 0x242448;
-      daylightColor: 0xeeeeee;
-      brightestColor: 0xffffff;
-      backgroundColor: 0x909090;
-      fogUnexplored: 0x000000;
-      fogExplored: 0x000000;
-    };
-
-    /**
-     * Returns the darkness penalty for the actual scene configuration.
-     */
-    get darknessPenalty(): number;
-
-    /**
-     * Get the darkness level of this scene.
-     */
-    get darknessLevel(): number;
-
-    /**
-     * Initialize color space pertaining to a specific scene.
-     */
-    initialize(colors?: {
-      /** The background canvas color */
-      backgroundColor?: Color | number | string;
-
-      /** The brightest ambient color */
-      brightestColor?: Color | number | string;
-
-      /** The color of darkness */
-      darknessColor?: Color | number | string;
-
-      /** A preview darkness level */
-      darknessLevel?: number;
-
-      /** The ambient daylight color */
-      daylightColor?: Color | number | string;
-
-      /** The color applied to explored areas */
-      fogExploredColor?: number;
-
-      /** The color applied to unexplored areas */
-      fogUnexploredColor?: number;
-    }): void;
-  }
-}

package/src/foundry/client/pixi/placeables/primary-canvas-objects/drawing-shape.d.mts

@@ -1,143 +0,0 @@
-import type { Document } from "../../../../common/abstract/module.d.mts";
-
-declare global {
-  /**
-   * A special subclass of PIXI.Container used to represent a Drawing in the PrimaryCanvasGroup.
-   */
-  class DrawingShape extends PrimaryCanvasObjectMixin(PIXI.Graphics) {
-    /**
-     * Sorting values to deal with ties.
-     */
-    static PRIMARY_SORT_ORDER: number;
-
-    /**
-     * @defaultValue
-     * ```js
-     * return foundry.utils.mergeObject(super.defaultData, {
-     *      shape: {
-     *          type: "",
-     *          width: 0,
-     *          height: 0,
-     *          radius: null,
-     *          points: []
-     *      },
-     *      bezierFactor: 0,
-     *      fillType: 0,
-     *      fillColor: 0x7C7C7C,
-     *      fillAlpha: 0.5,
-     *      strokeWidth: 8,
-     *      strokeColor: 0xFFFFFF,
-     *      strokeAlpha: 1,
-     *      text: "New Text",
-     *      fontFamily: "Signika",
-     *      fontSize: 48,
-     *      textColor: 0xFFFFFF,
-     *      textAlpha: 1
-     * })
-     * ```
-     */
-    static override get defaultData(): DrawingShape.PrimaryCanvasObjectDrawingShapeData;
-
-    override refresh(): void;
-
-    override setPosition(): void;
-
-    protected override _getCanvasDocumentData(data: Document.Any): unknown;
-
-    /**
-     * Draw rectangular shapes.
-     */
-    protected _drawRectangle(): void;
-
-    /**
-     * Draw ellipsoid shapes.
-     */
-    protected _drawEllipse(): void;
-
-    /**
-     * Draw polygonal shapes.
-     */
-    protected _drawPolygon(): void;
-
-    /**
-     * Draw freehand shapes with bezier spline smoothing.
-     */
-    protected _drawFreehand(): void;
-  }
-
-  namespace DrawingShape {
-    interface PrimaryCanvasObjectDrawingShapeData extends PrimaryCanvasObjectData {
-      /** The shape */
-      shape: object;
-
-      /** The x-coordinate of the PCO location */
-      x: number;
-
-      /** The y-coordinate of the PCO location */
-      y: number;
-
-      /** The z-index of the PCO */
-      z: number;
-
-      /** The bezier factor */
-      bezierFactor: number;
-
-      /** The fill type */
-      fillType: number;
-
-      /** The fill color */
-      fillColor: number;
-
-      /** The fill alpha */
-      fillAlpha: number;
-
-      /** The stroke width */
-      strokeWidth: number;
-
-      /** The stroke color */
-      strokeColor: number;
-
-      /** The stroke alpha */
-      strokeAlpha: number;
-
-      /** The text */
-      text: string;
-
-      /** The text font family */
-      fontFamily: string;
-
-      /** The font size */
-      fontSize: number;
-
-      /** The text color */
-      textColor: number;
-
-      /** The text alpha */
-      textAlpha: number;
-
-      /** The rotation of this PCO */
-      rotation: number;
-
-      /** The PCO is hidden? */
-      hidden: boolean;
-
-      /** The elevation of the PCO */
-      elevation: number;
-
-      /** The sort key that resolves ties among the same elevation */
-      sort: number;
-
-      /** The PCO is considered as a roof? */
-      roof: boolean;
-
-      /** The PCO is considered as overhead? */
-      overhead: boolean;
-
-      /** The occlusion object for this PCO */
-      occlusion: object;
-
-      /** The data texture values */
-      texture: PIXI.RenderTexture;
-    }
-  }
-}