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

package/src/foundry/client/pixi/layers/placeables/sounds.d.mts

@@ -1,316 +0,0 @@
-import type { IntentionalPartial, InexactPartial, NullishProps, HandleEmptyObject } from "fvtt-types/utils";
-import type { AmbientSoundEffect } from "../../../../common/documents/_types.d.mts";
-
-declare global {
-  /**
-   * This Canvas Layer provides a container for AmbientSound objects.
-   */
-  class SoundsLayer extends PlaceablesLayer<"AmbientSound"> {
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas["sounds"];
-
-    /**
-     * Track whether to actively preview ambient sounds with mouse cursor movements
-     * @defaultValue `false`
-     */
-    livePreview: boolean;
-
-    /**
-     * A mapping of ambient audio sources which are active within the rendered Scene
-     * @defaultValue `new foundry.utils.Collection()`
-     */
-    sources: foundry.utils.Collection<foundry.canvas.sources.PointSoundSource>;
-
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    override options: SoundsLayer.LayerOptions;
-
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *  name: "sounds",
-     *  zIndex: 900
-     * })
-     * ```
-     * */
-
-    static override get layerOptions(): SoundsLayer.LayerOptions;
-
-    static override documentName: "AmbientSound";
-
-    override get hookName(): string;
-
-    override _draw(options: HandleEmptyObject<SoundsLayer.DrawOptions>): Promise<void>;
-
-    override _tearDown(options: HandleEmptyObject<SoundsLayer.TearDownOptions>): Promise<void>;
-
-    override _activate(): void;
-
-    /**
-     * Initialize all AmbientSound sources which are present on this layer
-     */
-    initializeSources(): void;
-
-    /**
-     * Update all AmbientSound effects in the layer by toggling their playback status.
-     * Sync audio for the positions of tokens which are capable of hearing.
-     * @param options - Additional options forwarded to AmbientSound synchronization
-     *                  (defaultValue: `{}`)
-     */
-    refresh(
-      options?: NullishProps<{
-        /**
-         * A duration in milliseconds to fade volume transition
-         */
-        fade: number;
-      }>,
-    ): number | void;
-
-    /**
-     * Preview ambient audio for a given mouse cursor position
-     * @param position - The cursor position to preview
-     */
-    previewSound(position: Canvas.Point): void;
-
-    /**
-     * Terminate playback of all ambient audio sources
-     */
-    stopAll(): void;
-
-    /**
-     * Get an array of listener positions for Tokens which are able to hear environmental sound.
-     */
-    getListenerPositions(): Canvas.Point[];
-
-    /**
-     * Sync the playing state and volume of all AmbientSound objects based on the position of listener points
-     * @param listeners - Locations of listeners which have the capability to hear
-     * @param options   - Additional options forwarded to AmbientSound synchronization
-     *                    (defaultValue: `{}`)
-     */
-    protected _syncPositions(
-      listeners: Canvas.Point[],
-      options?: NullishProps<{
-        /**
-         * A duration in milliseconds to fade volume transition
-         */
-        fade: number;
-      }>,
-    ): void;
-
-    /**
-     * Configure playback by assigning the muffled state and final playback volume for the sound.
-     * This method should mutate the config object by assigning the volume and muffled properties.
-     * @param config - A playback configuration object
-     */
-    protected _configurePlayback(config: SoundsLayer.AmbientSoundPlaybackConfig): void;
-
-    /**
-     * Actions to take when the darkness level of the Scene is changed
-     * @param  event - The darkness-changing event
-     */
-    protected _onDarknessChange(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Play a one-shot Sound originating from a predefined point on the canvas.
-     * The sound plays locally for the current client only.
-     * To play a sound for all connected clients use SoundsLayer#emitAtPosition.
-     * @param src     - The sound source path to play
-     * @param origin  - The canvas coordinates from which the sound originates
-     * @param radius  - The radius of effect in distance units
-     * @param options - Additional options which configure playback
-     * @returns  A Promise which resolves to the played Sound, or null
-     *
-     * @example Play the sound of a trap springing
-     * ```js
-     * const src = "modules/my-module/sounds/spring-trap.ogg";
-     * const origin = {x: 5200, y: 3700};  // The origin point for the sound
-     * const radius = 30;                  // Audible in a 30-foot radius
-     * await canvas.sounds.playAtPosition(src, origin, radius);
-     * ```
-     *
-     * @example A Token casts a spell
-     * ```js
-     * const src = "modules/my-module/sounds/spells-sprite.ogg";
-     * const origin = token.center;         // The origin point for the sound
-     * const radius = 60;                   // Audible in a 60-foot radius
-     * await canvas.sounds.playAtPosition(src, origin, radius, {
-     *   walls: false,                      // Not constrained by walls with a lowpass muffled effect
-     *   muffledEffect: {type: "lowpass", intensity: 6},
-     *   sourceData: {
-     *     angle: 120,                      // Sound emitted at a limited angle
-     *     rotation: 270                    // Configure the direction of sound emission
-     *   }
-     *   playbackOptions: {
-     *     loopStart: 12,                   // Audio sprite timing
-     *     loopEnd: 16,
-     *     fade: 300,                      // Fade-in 300ms
-     *     onended: () => console.log("Do something after the spell sound has played")
-     *   }
-     * });
-     * ```
-     */
-    playAtPosition(
-      src: string,
-      origin: Canvas.Point,
-      radius: number,
-      /** @remarks Can't be NullishProps because a default for `volume` is provided only for `undefined` with `{ volume=1 }`, which must be numeric */
-      options?: InexactPartial<SoundsLayer.PlayAtPositionOptions>,
-    ): Promise<foundry.audio.Sound | null>;
-
-    /**
-     * Emit playback to other connected clients to occur at a specified position.
-     * @param args - Arguments passed to SoundsLayer#playAtPosition
-     * @returns  A Promise which resolves once playback for the initiating client has completed
-     */
-    emitAtPosition(...args: Parameters<this["playAtPosition"]>): ReturnType<this["playAtPosition"]>;
-
-    /**
-     * Handle mouse cursor movements which may cause ambient audio previews to occur
-     */
-    protected _onMouseMove(): void;
-
-    protected override _onDragLeftStart(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftDrop(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftCancel(event: PointerEvent): void;
-
-    /**
-     * Handle PlaylistSound document drop data.
-     * @param event - The drag drop event
-     * @param data  - The dropped transfer data.
-     */
-    protected _onDropData(
-      event: DragEvent,
-      data: SoundsLayer.DropData,
-    ): Promise<ReturnType<PlaceablesLayer<"AmbientSound">["_createPreview"]> | false>;
-  }
-
-  namespace SoundsLayer {
-    type AnyConstructor = typeof AnySoundsLayer;
-
-    interface DrawOptions extends PlaceablesLayer.DrawOptions {}
-
-    interface TearDownOptions extends PlaceablesLayer.TearDownOptions {}
-
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"AmbientSound"> {
-      name: "sounds";
-      zIndex: 900;
-    }
-
-    interface DropData extends Canvas.DropPosition {
-      type: "PlaylistSound";
-      uuid: string;
-    }
-
-    interface PlayAtPositionOptions {
-      /**
-       * The maximum volume at which the effect should be played
-       * @defaultValue `1.0`
-       */
-      volume: number;
-
-      /**
-       * Should volume be attenuated by distance?
-       * @defaultValue `true`
-       */
-      easing: boolean;
-
-      /**
-       * Should the sound be constrained by walls?
-       * @defaultValue `true`
-       */
-      walls: boolean;
-
-      /**
-       * Should the sound always be played for GM users regardless of actively controlled tokens?
-       * @defaultValue `true`
-       */
-      gmAlways: boolean;
-
-      /** A base sound effect to apply to playback */
-      baseEffect: AmbientSoundEffect;
-
-      /** A muffled sound effect to apply to playback, a sound may only be muffled if it is not constrained by walls */
-      muffledEffect: AmbientSoundEffect;
-
-      /**
-       * Additional data passed to the SoundSource constructor
-       * @remarks IntentionalPartial because this is spread into an object with existing keys
-       */
-      sourceData: IntentionalPartial<PointSourceData>;
-
-      /** Additional options passed to Sound#play */
-      playbackOptions: foundry.audio.Sound.PlaybackOptions;
-    }
-
-    interface AmbientSoundPlaybackConfig {
-      /**
-       * The Sound node which should be controlled for playback
-       */
-      sound: foundry.audio.Sound;
-
-      /**
-       * The SoundSource which defines the area of effect for the sound
-       */
-      source: foundry.canvas.sources.PointSoundSource;
-
-      /**
-       * An AmbientSound object responsible for the sound, or undefined
-       */
-      object: AmbientSound | undefined;
-
-      /**
-       * The coordinates of the closest listener or undefined if there is none
-       */
-      listener: Canvas.Point | undefined;
-
-      /**
-       * The minimum distance between a listener and the AmbientSound origin
-       */
-      distance: number;
-
-      /**
-       * Is the closest listener muffled
-       */
-      muffled: boolean;
-
-      /**
-       * Is playback constrained or muffled by walls?
-       */
-      walls: boolean;
-
-      /**
-       * The final volume at which the Sound should be played
-       */
-      volume: number;
-    }
-  }
-}
-
-/**
- * @privateRemarks This is the only place in v12 (and v13 as of 332) where this v11 type is still used
- */
-interface PointSourceData {
-  x: number;
-  y: number;
-  elevation: number;
-  z: number | null;
-  radius: number;
-  externalRadius: number;
-  rotation: number;
-  angle: number;
-  walls: boolean;
-  disabled: boolean;
-}
-
-declare abstract class AnySoundsLayer extends SoundsLayer {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/layers/placeables/templates.d.mts

@@ -1,69 +0,0 @@
-import type { HandleEmptyObject } from "fvtt-types/utils";
-
-/**
- * This Canvas Layer provides a container for MeasuredTemplate objects.
- * @see {@link MeasuredTemplate}
- */
-declare global {
-  class TemplateLayer extends PlaceablesLayer<"MeasuredTemplate"> {
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas["templates"];
-
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    override options: TemplateLayer.LayerOptions;
-
-    /**
-     * @defaultValue
-     * ```
-     * mergeObject(super.layerOptions, {
-     *   name: "templates",
-     *   rotatableObjects: true,
-     *   zIndex: 400
-     * })
-     * ```
-     */
-    static override get layerOptions(): TemplateLayer.LayerOptions;
-
-    static override documentName: "MeasuredTemplate";
-
-    override get hookName(): string;
-
-    override _deactivate(): void;
-
-    override _draw(options: HandleEmptyObject<TemplateLayer.DrawOptions>): Promise<void>;
-
-    /**
-     * Register game settings used by the TemplatesLayer
-     */
-    static registerSettings(): void;
-
-    protected override _onDragLeftStart(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.FederatedEvent): void;
-
-    // @ts-expect-error Foundry is changing the return type here from Promise<PlaceableObject[]> to Promise<MeasuredTemplate>
-    protected override _onMouseWheel(
-      event: WheelEvent,
-    ): ReturnType<MeasuredTemplate.ConfiguredInstance["rotate"]> | void;
-  }
-
-  namespace TemplateLayer {
-    type AnyConstructor = typeof AnyTemplateLayer;
-
-    interface DrawOptions extends PlaceablesLayer.DrawOptions {}
-
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"MeasuredTemplate"> {
-      name: "templates";
-      rotatableObjects: true;
-      zIndex: 400;
-    }
-  }
-}
-
-declare abstract class AnyTemplateLayer extends TemplateLayer {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/layers/placeables/tiles.d.mts

@@ -1,114 +0,0 @@
-import type { HandleEmptyObject } from "../../../../../utils/index.d.mts";
-import type BaseTile from "../../../../common/documents/tile.d.mts";
-
-declare global {
-  /**
-   * A PlaceablesLayer designed for rendering the visual Scene for a specific vertical cross-section.
-   */
-  class TilesLayer extends PlaceablesLayer<"Tile"> {
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas["tiles"];
-
-    static override documentName: "Tile";
-
-    override options: TilesLayer.LayerOptions;
-
-    /**
-     * @defaultValue
-     * ```js
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *    name: "tiles",
-     *    zIndex: 300,
-     *    controllableObjects: true,
-     *    rotatableObjects: true,
-     * })
-     * ```
-     */
-    static override get layerOptions(): TilesLayer.LayerOptions;
-
-    override get hookName(): string;
-
-    override get hud(): TileHUD;
-
-    /**
-     * An array of Tile objects which are rendered within the objects container
-     */
-    get tiles(): Tile.ConfiguredInstance[];
-
-    override controllableObjects(): Generator<Tile.ConfiguredInstance>;
-
-    override getSnappedPoint(point: Canvas.Point): Canvas.Point;
-
-    protected override _tearDown(options: HandleEmptyObject<TilesLayer.TearDownOptions>): Promise<void>;
-
-    protected override _onDragLeftStart(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftDrop(event: PIXI.FederatedEvent): void;
-
-    protected override _onDragLeftCancel(event: PointerEvent): void;
-
-    /**
-     * Handle drop events for Tile data on the Tiles Layer
-     * @param event - The concluding drag event
-     * @param data  - The extracted Tile data
-     */
-    protected _onDropData(
-      event: DragEvent,
-      data: BaseTile.ConstructorData,
-    ): Promise<TileDocument.ConfiguredInstance | false | void>;
-
-    /**
-     * Prepare the data object when a new Tile is dropped onto the canvas
-     * @param event - The concluding drag event
-     * @param data  - The extracted Tile data
-     * @returns The prepared data to create
-     */
-    _getDropData(event: DragEvent, data: BaseTile.ConstructorData): Promise<BaseTile.ConstructorData>;
-
-    /**
-     * Get an array of overhead Tile objects which are roofs
-     * @deprecated since v12 until v14
-     * @remarks "TilesLayer#roofs has been deprecated without replacement."
-     */
-    get roofs(): Tile.ConfiguredInstance[];
-
-    /**
-     * @deprecated since v11, will be removed in v13
-     * @remarks "TilesLayer#textureDataMap has moved to TextureLoader.textureBufferDataMap"
-     */
-    get textureDataMap(): (typeof TextureLoader)["textureBufferDataMap"];
-
-    /**
-     * A convenience reference to the tile occlusion mask on the primary canvas group.
-     * @deprecated since v11 until v13
-     * @remarks "TilesLayer#depthMask is deprecated without replacement. Use canvas.masks.depth instead"
-     */
-    get depthMask(): CachedContainer;
-  }
-
-  namespace TilesLayer {
-    type AnyConstructor = typeof AnyTilesLayer;
-
-    interface TearDownOptions extends PlaceablesLayer.TearDownOptions {}
-
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"Tile"> {
-      name: "tiles";
-      zIndex: 300;
-      controllableObjects: true;
-      rotatableObjects: true;
-    }
-
-    interface DropData extends Canvas.DropPosition {
-      type: "Tile";
-      uuid: string;
-    }
-  }
-}
-
-declare abstract class AnyTilesLayer extends TilesLayer {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/layers/placeables/tokens.d.mts

@@ -1,189 +0,0 @@
-import type { ArrayOverlaps, HandleEmptyObject, NullishProps } from "fvtt-types/utils";
-import type Document from "../../../../common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * The Tokens Container
-   */
-  class TokenLayer extends PlaceablesLayer<"Token"> {
-    /**
-     * The current index position in the tab cycle
-     * @defaultValue `null`
-     * @remarks Foundry marked \@private but accesses it from Canvas
-     */
-    _tabIndex: number | null;
-
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas["tokens"];
-
-    /**
-     * @privateRemarks This is not overridden in foundry but reflects the real behavior.
-     */
-    override options: TokenLayer.LayerOptions;
-
-    /**
-     * @defaultValue
-     * ```js
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *  name: "tokens",
-     *  controllableObjects: true,
-     *  rotatableObjects: true,
-     *  zIndex: 200
-     * })
-     * ```
-     */
-    static override get layerOptions(): TokenLayer.LayerOptions;
-
-    static override documentName: "Token";
-
-    /**
-     * The set of tokens that trigger occlusion (a union of {@link CONST.TOKEN_OCCLUSION_MODES}).
-     */
-    set occlusionMode(value: number);
-
-    get occlusionMode(): number;
-
-    override get hookName(): string;
-
-    /**
-     * Token objects on this layer utilize the TokenHUD
-     */
-    get hud(): TokenHUD;
-
-    /**
-     * An Array of tokens which belong to actors which are owned
-     */
-    get ownedTokens(): ReturnType<this["placeables"]["filter"]>;
-
-    override getSnappedPoint(point: Canvas.Point): Canvas.Point;
-
-    protected override _draw(options: HandleEmptyObject<TokenLayer.DrawOptions>): Promise<void>;
-
-    protected override _tearDown(options: HandleEmptyObject<TokenLayer.TearDownOptions>): Promise<void>;
-
-    protected override _activate(): void;
-
-    protected override _deactivate(): void;
-
-    override _pasteObject(
-      copy: Token.ConfiguredInstance,
-      offset: Canvas.Point,
-      options?: NullishProps<{ hidden: boolean; snap: boolean }>,
-    ): Document.ConfiguredSourceForName<"Token">;
-
-    protected override _getMovableObjects<const T>(
-      ids?: ArrayOverlaps<T, string>,
-      includeLocked?: boolean,
-    ): Token.ConfiguredInstance[];
-
-    /**
-     * Target all Token instances which fall within a coordinate rectangle.
-     * @param rectangle - The selection rectangle.
-     * @param options - Additional options to configure targeting behaviour.
-     */
-    targetObjects(rectangle: Canvas.Rectangle, options?: NullishProps<PlaceableObject.ControlOptions>): number;
-
-    /**
-     * Cycle the controlled token by rotating through the list of Owned Tokens that are available within the Scene
-     * Tokens are currently sorted in order of their TokenID
-     * @param forwards - Which direction to cycle. A truthy value cycles forward, while a false value cycles backwards.
-     * @param reset    - Restart the cycle order back at the beginning?
-     */
-    cycleTokens(forwards: boolean, reset: boolean): Token.ConfiguredInstance | null;
-
-    /**
-     * Get the tab cycle order for tokens by sorting observable tokens based on their distance from top-left.
-     */
-    protected _getCycleOrder(): Token.ConfiguredInstance[];
-
-    /**
-     * Immediately conclude the animation of any/all tokens
-     */
-    concludeAnimation(): void;
-
-    /**
-     * Animate targeting arrows on targeted tokens.
-     */
-    protected _animateTargets(): void;
-
-    /**
-     * Provide an array of Tokens which are eligible subjects for overhead tile occlusion.
-     * By default, only tokens which are currently controlled or owned by a player are included as subjects.
-     */
-    protected _getOccludableTokens(): Token.ConfiguredInstance[];
-
-    override storeHistory(
-      type: PlaceablesLayer.HistoryEventType,
-      data: Document.ConfiguredSourceForName<"Token">[],
-    ): void;
-
-    /**
-     * Handle dropping of Actor data onto the Scene canvas
-     */
-    protected _onDropActorData(
-      event: DragEvent,
-      data: TokenLayer.DropData,
-    ): Promise<ReturnType<foundry.applications.ui.Notifications["warn"]> | false | TokenDocument.ConfiguredInstance>;
-
-    //TODO: use configured ruler type once it exists
-    protected override _onClickLeft(event: PIXI.FederatedEvent): void; // ReturnType<CONFIG.Canvas["rulerClass"]["_onClickLeft"]>;
-
-    protected override _onMouseWheel(event: WheelEvent): ReturnType<this["rotateMany"]>;
-
-    /**
-     * @deprecated since v12 until v14
-     * @remarks "TokenLayer#toggleCombat is deprecated in favor of TokenDocument.implementation.createCombatants and TokenDocument.implementation.deleteCombatants"
-     */
-    override get gridPrecision(): 1;
-
-    /**
-     * Add or remove the set of currently controlled Tokens from the active combat encounter
-     * @param  state  - The desired combat state which determines if each Token is added (true) or removed (false)
-     *                  (default: `true`)
-     * @param  combat - A Combat encounter from which to add or remove the Token
-     *                  (default: `null`)
-     * @returns The Combatants added or removed
-     * @deprecated since v12 until v14
-     * @remarks "TokenLayer#toggleCombat is deprecated in favor of TokenDocument.implementation.createCombatants and TokenDocument.implementation.deleteCombatants"
-     */
-    toggleCombat(
-      state?: boolean,
-      combat?: Combat.ConfiguredInstance | null,
-      {
-        token,
-      }?: {
-        /**
-         * A specific Token which is the origin of the group toggle request
-         * @defaultValue `null`
-         */
-        token?: Token.ConfiguredInstance | null;
-      },
-    ): Promise<Combatant.ConfiguredInstance[]>;
-  }
-
-  namespace TokenLayer {
-    type AnyConstructor = typeof AnyTokenLayer;
-
-    interface DrawOptions extends PlaceablesLayer.DrawOptions {}
-
-    interface TearDownOptions extends PlaceablesLayer.TearDownOptions {}
-
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"Token"> {
-      name: "tokens";
-      controllableObjects: true;
-      rotatableObjects: true;
-      zIndex: 200;
-    }
-
-    interface DropData extends Canvas.DropPosition {
-      type: "Actor";
-      uuid: string;
-    }
-  }
-}
-
-declare abstract class AnyTokenLayer extends TokenLayer {
-  constructor(arg0: never, ...args: never[]);
-}