@league-of-foundry-developers/foundry-vtt-types 9.269.1 → 9.280.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.269.1",
+  "version": "9.280.1",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {

package/src/foundry/client/pixi/board.d.ts

@@ -42,6 +42,12 @@ declare global {
      */
     hud: HeadsUpDisplay | null;
 
+    /**
+     * Position of the mouse on stage.
+     * @type {PIXI.Point}
+     */
+    mousePosition: PIXI.Point;
+
     /**
      * An Array of pending canvas operations which should trigger on the next re-paint
      * @defaultValue `[]`
@@ -328,7 +334,7 @@ declare global {
      *               (default: `{}`)
      * @returns A Promise which resolves once the animation has been completed
      */
-    animatePan(view?: Partial<AnimatedPanView>): ReturnType<typeof CanvasAnimation.animateLinear>;
+    animatePan(view?: AnimatedPanView): ReturnType<typeof CanvasAnimation.animateLinear>;
 
     /**
      * Recenter the canvas
@@ -575,28 +581,28 @@ interface AnimatedPanView {
   /**
    * The destination x-coordinate
    */
-  x?: number;
+  x?: number | null;
 
   /**
    * The destination y-coordinate
    */
-  y?: number;
+  y?: number | null;
 
   /**
    * The destination zoom scale
    */
-  scale?: number;
+  scale?: number | null;
 
   /**
    * The total duration of the animation in milliseconds; used if speed is not set
    * @defaultValue 250
    */
-  duration: number;
+  duration?: number | null;
 
   /**
    * The speed of animation in pixels per second; overrides duration if set
    */
-  speed?: number;
+  speed?: number | null;
 }
 
 interface EmbeddedEntityNameToLayerMap {

package/src/foundry/client/pixi/core/loader.d.ts

@@ -2,14 +2,9 @@ import type { ConfiguredDocumentClassForName } from '../../../../types/helperTyp
 
 declare global {
   /**
-   * A Loader class which helps with loading video and image textures
+   * A Loader class which helps with loading video and image textures.
    */
   class TextureLoader {
-    /**
-     * The cached mapping of textures
-     */
-    cache: Map<string, { tex: PIXI.BaseTexture; time: number }>;
-
     /**
      * The duration in milliseconds for which a texture will remain cached
      * @defaultValue `1000 * 60 * 15`
@@ -43,51 +38,26 @@ declare global {
     loadTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
-     * Log texture loading progress in the console and in the Scene loading bar
-     * @internal
+     * Load an image texture from a provided source url.
+     * @param src - The source image URL
+     * @returns The loaded BaseTexture
      */
-    protected _onProgress(src: string, progress: TextureLoader.Progress): void;
-
-    /**
-     * Log failed texture loading
-     * @internal
-     */
-    protected _onError(src: string, progress: TextureLoader.Progress, error: Error): void;
+    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
-     * Load an image texture from a provided source url
+     * @param src - The source video URL
+     * @returns The loaded BaseTexture
      */
-    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
+    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
      * Use the Fetch API to retrieve a resource and return a Blob instance for it.
+     * @param src     -
      * @param options - Options to configure the loading behaviour.
      *                  (default: `{}`)
-     * @internal
-     */
-    protected _fetchResource(
-      src: string,
-      options?: {
-        /**
-         * Append a cache-busting query parameter to the request.
-         * @defaultValue `false`
-         */
-        bustCache?: boolean | undefined;
-      }
-    ): Promise<Blob>;
-
-    /**
-     * Return a URL with a cache-busting query parameter appended.
-     * @param src - The source URL being attempted
-     * @returns The new URL, or false on a failure.
-     * @internal
+     * @returns A Blob containing the loaded data
      */
-    protected _getCacheBustURL(src: string): string | false;
-
-    /**
-     * Load a video texture from a provided source url
-     */
-    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
+    static fetchResource(src: string, options?: TextureLoader.FetchResourceOptions): Promise<Blob>;
 
     /**
      * Add an image url to the texture cache
@@ -107,6 +77,13 @@ declare global {
      */
     expireCache(): void;
 
+    /**
+     * Return a URL with a cache-busting query parameter appended.
+     * @param  src - The source URL being attempted
+     * @returns The new URL, or false on a failure.
+     */
+    static getCacheBustURL(src: string): string | false;
+
     /**
      * A global reference to the singleton texture loader
      */
@@ -142,6 +119,14 @@ declare global {
       total: number;
       pct: number;
     }
+
+    interface FetchResourceOptions {
+      /**
+       * Append a cache-busting query parameter to the request.
+       * @defaultValue `false`
+       */
+      bustCache?: boolean;
+    }
   }
 
   /**
@@ -160,11 +145,12 @@ declare global {
    * Load a single texture and return a Promise which resolves once the texture is ready to use
    * @param src      - The requested texture source
    * @param options  - Additional options which modify texture loading
+   * @returns The loaded Texture, or null if loading failed with no fallback
    */
   function loadTexture(
     src: string,
     options?: {
-      /** A fallback texture to use if the requested source is unavailable or invalid */
+      /** A fallback texture URL to use if the requested source is unavailable */
       fallback?: string | undefined;
     }
   ): Promise<PIXI.Texture | null>;