@league-of-foundry-developers/foundry-vtt-types 9.238.0 → 9.249.0

package/src/foundry/foundry.js/textureLoader.d.ts

@@ -8,11 +8,11 @@ declare global {
     /**
      * The cached mapping of textures
      */
-    cache: Map<string, { tex: PIXI.Texture; time: number }>;
+    cache: Map<string, { tex: PIXI.BaseTexture; time: number }>;
 
     /**
      * The duration in milliseconds for which a texture will remain cached
-     * @defaultValue `1000`
+     * @defaultValue `1000 * 60 * 15`
      */
     static CACHE_TTL: number;
 
@@ -33,14 +33,14 @@ declare global {
      * @param options - Additional options which modify loading
      * @returns A Promise which resolves once all textures are loaded
      */
-    load(sources: string[], options?: Partial<TextureLoader.LoadOptions>): Promise<void[]>;
+    load(sources: string[], options?: Partial<TextureLoader.LoadOptions>): Promise<PIXI.BaseTexture | void[]>;
 
     /**
      * Load a single texture on-demand from a given source URL path
      * @param src - The source texture path to load
      * @returns The loaded texture object
      */
-    loadTexture(src: string): Promise<PIXI.Texture>;
+    loadTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
      * Log texture loading progress in the console and in the Scene loading bar
@@ -57,40 +57,50 @@ declare global {
     /**
      * Load an image texture from a provided source url
      */
-    loadImageTexture(src: string): Promise<PIXI.Texture>;
+    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
-     * If an attempted image load failed, we may attempt a re-load in case the issue was CORS + caching
-     * Cross-origin requests which failed might be CORS, or might be 404, no way to know - so try a 2nd time
-     * @param src     - The source URL being attempted
-     * @param resolve - Resolve the promise
-     * @param reject  - Reject the promise
+     * Use the Fetch API to retrieve a resource and return a Blob instance for it.
+     * @param options - Options to configure the loading behaviour.
+     *                  (default: `{}`)
      * @internal
      */
-    protected _attemptCORSReload<T>(
+    protected _fetchResource(
       src: string,
-      resolve: (tex: PIXI.Texture) => void,
-      reject: (reason: string) => T
-    ): Promise<PIXI.Texture | T>;
+      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
+     */
+    protected _getCacheBustURL(src: string): string | false;
 
     /**
      * Load a video texture from a provided source url
-     * @param src -
      */
-    loadVideoTexture(src: string): Promise<PIXI.Texture>;
+    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
      * Add an image url to the texture cache
      * @param src - The source URL
      * @param tex - The readied texture
      */
-    setCache(src: string, tex: PIXI.Texture): void;
+    setCache(src: string, tex: PIXI.BaseTexture): void;
 
     /**
      * Retrieve a texture from the texture cache
      * @param src - The source URL
      */
-    getCache(src: string): PIXI.Texture | undefined;
+    getCache(src: string): PIXI.BaseTexture | undefined;
 
     /**
      * Expire (and destroy) textures from the cache which have not been used for more than CACHE_TTL milliseconds.

package/src/foundry/foundry.js/textureUtils.d.ts

@@ -13,16 +13,13 @@ declare function getTexture(src: string): PIXI.Texture | null;
 /**
  * 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
  * @param fallback - A fallback texture to use if the requested source is unavailable or invalid
  */
 declare function loadTexture(
   src: string,
-  {
-    fallback
-  }?: {
-    /**
-     * A fallback texture to use if the requested source is unavailable or invalid
-     */
-    fallback?: string;
+  options?: {
+    /** A fallback texture to use if the requested source is unavailable or invalid */
+    fallback?: string | undefined;
   }
-): Promise<PIXI.Texture>;
+): Promise<PIXI.Texture | null>;

package/src/foundry/foundry.js/videoHelper.d.ts

@@ -65,7 +65,8 @@ declare class VideoHelper {
    * The thumbnail is cached using the video file path or URL.
    * @param src     - The source video URL
    * @param options - Thumbnail creation options, including width and height
-   * @returns The created and cached base64 thumbnail image
+   * @returns The created and cached base64 thumbnail image, or a placeholder image if the canvas is
+   *          disabled and no thumbnail can be generated.
    */
   createThumbnail(src: string, options: ImageHelper.CompositeOptions): Promise<string>;
 }

package/src/foundry/index.d.ts

@@ -1,9 +1,10 @@
 import './common/module.mjs';
-
 import './foundry.js/application';
+import './foundry.js/applications';
 import './foundry.js/audioContainer';
 import './foundry.js/audioHelper';
 import './foundry.js/avClient';
+import './foundry.js/avClients';
 import './foundry.js/avMaster';
 import './foundry.js/avSettings';
 import './foundry.js/cameraPopoutAppWrapper';
@@ -12,10 +13,12 @@ import './foundry.js/canvasAnimation';
 import './foundry.js/canvasDocumentMixin';
 import './foundry.js/chatBubbles';
 import './foundry.js/clientDatabaseBackend';
-import './foundry.js/clientDocuments';
 import './foundry.js/clientDocumentMixin';
+import './foundry.js/clientDocuments';
 import './foundry.js/clientKeybindings';
 import './foundry.js/clientSettings';
+import './foundry.js/collections';
+import './foundry.js/collisionResult';
 import './foundry.js/config';
 import './foundry.js/constants';
 import './foundry.js/contextMenu';
@@ -25,8 +28,8 @@ import './foundry.js/features';
 import './foundry.js/fonts';
 import './foundry.js/formDataExtended';
 import './foundry.js/game';
-import './foundry.js/gamepadManager';
 import './foundry.js/gameTime';
+import './foundry.js/gamepadManager';
 import './foundry.js/globalVariables';
 import './foundry.js/handlebarsHelpers';
 import './foundry.js/hooks';
@@ -38,16 +41,34 @@ import './foundry.js/mouseInteractionManager';
 import './foundry.js/mouseManager';
 import './foundry.js/newUserExperience';
 import './foundry.js/perceptionManager';
+import './foundry.js/pixi';
 import './foundry.js/pointSource';
+import './foundry.js/pointSources';
+import './foundry.js/polygonEdge';
+import './foundry.js/polygonVertex';
 import './foundry.js/quadtree';
+import './foundry.js/quadtreeCulling';
 import './foundry.js/ray';
+import './foundry.js/rays';
 import './foundry.js/roll';
+import './foundry.js/rollTerm';
+import './foundry.js/rollTerms/diceTerm';
+import './foundry.js/rollTerms/diceTerms/coin';
+import './foundry.js/rollTerms/diceTerms/die';
+import './foundry.js/rollTerms/diceTerms/fateDie';
+import './foundry.js/rollTerms/mathTerm';
+import './foundry.js/rollTerms/numericTerm';
+import './foundry.js/rollTerms/operatorTerm';
+import './foundry.js/rollTerms/parentheticalTerm';
+import './foundry.js/rollTerms/poolTerm';
+import './foundry.js/rollTerms/stringTerm';
+import './foundry.js/screenCulling';
 import './foundry.js/searchFilter';
-import './foundry.js/specialEffect';
-import './foundry.js/specialEffects';
 import './foundry.js/socketInterface';
 import './foundry.js/sortingHelpers';
 import './foundry.js/sound';
+import './foundry.js/specialEffect';
+import './foundry.js/specialEffects';
 import './foundry.js/tabs';
 import './foundry.js/templateUtils';
 import './foundry.js/textEditor';
@@ -57,25 +78,3 @@ import './foundry.js/types';
 import './foundry.js/userTargets';
 import './foundry.js/utils';
 import './foundry.js/videoHelper';
-
-import './foundry.js/applications';
-
-import './foundry.js/avClients';
-
-import './foundry.js/collections';
-
-import './foundry.js/rollTerm';
-
-import './foundry.js/rollTerms/diceTerm';
-import './foundry.js/rollTerms/mathTerm';
-import './foundry.js/rollTerms/numericTerm';
-import './foundry.js/rollTerms/operatorTerm';
-import './foundry.js/rollTerms/parentheticalTerm';
-import './foundry.js/rollTerms/poolTerm';
-import './foundry.js/rollTerms/stringTerm';
-
-import './foundry.js/rollTerms/diceTerms/coin';
-import './foundry.js/rollTerms/diceTerms/die';
-import './foundry.js/rollTerms/diceTerms/fateDie';
-
-import './foundry.js/pixi';

package/src/foundry/foundry.js/pixi/polygons/sourcePolygon.d.ts

@@ -1,25 +0,0 @@
-/**
- * An extension of the base PIXI.Polygon class designed for polygons which are constructed as a radius around
- * some central origin.
- */
-declare class SourcePolygon extends PIXI.Polygon {
-  constructor(x: number, y: number, radius: number, ...points: ({ x: number; y: number }[] | number[])[]);
-
-  x: number;
-
-  y: number;
-
-  radius: number;
-
-  /** @override */
-  clone(): this;
-
-  /**
-   * Optimize Polygon membership test by first checking the hypotenuse of the candidate point against the known origin
-   * @see PIXI.Polygon#contains
-   * @param x - The candidate x-coordinate
-   * @param y - The candidate y-coordinate
-   * @returns Is the provided point contained within the SourcePolygon?
-   */
-  contains(x: number, y: number): boolean;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShader.d.ts

@@ -1,21 +0,0 @@
-/**
- * The default coloration shader used by standard rendering and animations.
- * A fragment shader which creates a light source.
- */
-declare class StandardColorationShader extends AbstractBaseShader {
-  static fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   alpha: 1.0,
-   *   color: [1.0, 1.0, 1.0],
-   *   time: 0,
-   *   intensity: 5,
-   *   darkness: false,
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/chromaColorationShader.d.ts

@@ -1,18 +0,0 @@
-/**
- * Chroma animation coloration shader
- */
-declare class ChromaColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   pulse: 0,
-   *   color: PIXI.utils.hex2rgb(0xCEECEE)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/emanationColorationShader.d.ts

@@ -1,17 +0,0 @@
-/**
- * Emanation animation coloration shader
- */
-declare class EmanationColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   color: PIXI.utils.hex2rgb(0xCEECEE)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/energyFieldColorationShader.d.ts

@@ -1,18 +0,0 @@
-/**
- * Energy field animation coloration shader
- */
-declare class EnergyFieldColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   pulse: 0,
-   *   color: PIXI.utils.hex2rgb(0xCEECEE)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/fogColorationShader.d.ts

@@ -1,17 +0,0 @@
-/**
- * Fog animation coloration shader
- */
-declare class FogColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   color: PIXI.utils.hex2rgb(0xCCCCCC)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/hexaDomeColorationShader.d.ts

@@ -1,17 +0,0 @@
-/**
- * Hexagonal dome animation coloration shader
- */
-declare class HexaDomeColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   color: PIXI.utils.hex2rgb(0xCEECEE)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/lightDomeColorationShader.d.ts

@@ -1,17 +0,0 @@
-/**
- * Light dome animation coloration shader
- */
-declare class LightDomeColorationShader extends StandardColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   color: PIXI.utils.hex2rgb(0xCEECEE)
-   * })
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardIlluminationShader.d.ts

@@ -1,22 +0,0 @@
-/**
- * The default coloration shader used by standard rendering and animations
- * A fragment shader which creates a solid light source.
- */
-declare class StandardIlluminationShader extends AbstractBaseShader {
-  static fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   alpha: 1.0,
-   *   ratio: 0.5,
-   *   colorDim: [0.5, 0.5, 0.5],
-   *   colorBright: [1.0, 1.0, 1.0],
-   *   time: 0,
-   *   intensity: 5
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-}