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

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

@@ -249,6 +249,9 @@ declare global {
       /** @defaultValue `Cards` */
       documentClass: ConfiguredDocumentClassOrDefault<typeof Cards>;
 
+      /** @defaultValue `"fas fa-id-badge"` */
+      sidebarIcon: string;
+
       presets: {
         /**
          * @defaultValue
@@ -328,19 +331,7 @@ declare global {
       /** @defaultValue `[Die, FateDie]` */
       types: Array<ConstructorOf<DiceTerm>>;
 
-      rollModes: {
-        /** @defaultValue `'CHAT.RollPublic'` */
-        roll: string;
-
-        /** @defaultValue `'CHAT.RollPrivate'` */
-        gmroll: string;
-
-        /** @defaultValue `CHAT.RollBlind'` */
-        blindroll: string;
-
-        /** @defaultValue `'CHAT.RollSelf'` */
-        selfroll: string;
-      } & Record<string, string>;
+      rollModes: CONFIG.Dice.RollModes;
 
       /** @defaultValue `[Roll]` */
       rolls: Array<ConstructorOf<Roll>>;
@@ -517,7 +508,7 @@ declare global {
       /** @defaultValue `Macros` */
       collection: ConstructorOf<Macros>;
 
-      /** @defaultValue `'fas fa-terminal'` */
+      /** @defaultValue `'fas fa-code'` */
       sidebarIcon: string;
     };
 
@@ -599,7 +590,7 @@ declare global {
       blurStrength: number;
 
       /** @defaultValue `ScreenCulling` */
-      cullingBackend: unknown; // FIXME: ConstructorOf<typeof ScreenCulling>
+      cullingBackend: ConstructorOf<typeof ScreenCulling | typeof QuadtreeCulling>;
 
       /** @defaultValue `0x242448` */
       darknessColor: number;
@@ -665,8 +656,8 @@ declare global {
           /** @defaultValue `'LIGHT.AnimationTorch'` */
           label: string;
 
-          /** @defaultValue LightSource.prototype.animateTorch */
-          animation: PointSource.AnimationFunction;
+          /** @defaultValue `LightSource.prototype.animateTorch` */
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `TorchIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -680,7 +671,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animatePulse` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `PulseIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -694,7 +685,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `ChromaColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -705,7 +696,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `WaveIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -719,7 +710,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `FogColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -730,7 +721,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `SunburstIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -744,7 +735,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `LightDomeColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -755,7 +746,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `EmanationColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -766,7 +757,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `HexaDomeColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -777,7 +768,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `GhostLightIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -791,7 +782,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `EnergyFieldColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -802,7 +793,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `RoilingIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -813,7 +804,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `BlackHoleIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -824,7 +815,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `VortexIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -838,7 +829,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `BewitchingWaveIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -852,7 +843,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `SwirlingRainbowColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -863,7 +854,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `RadialRainbowColorationShader` */
           colorationShader: ConstructorOf<AbstractBaseShader>;
@@ -874,7 +865,7 @@ declare global {
           label: string;
 
           /** @defaultValue `LightSource.prototype.animateTime` */
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
 
           /** @defaultValue `FairyLightIlluminationShader` */
           illuminationShader: ConstructorOf<AbstractBaseShader>;
@@ -886,7 +877,7 @@ declare global {
         string,
         {
           label: string;
-          animation: PointSource.AnimationFunction;
+          animation: CONFIG.Canvas.LightAnimationFunction;
           illuminationShader?: ConstructorOf<AbstractBaseShader>;
           colorationShader?: ConstructorOf<AbstractBaseShader>;
         }
@@ -985,7 +976,7 @@ declare global {
 
     /**
      * Suggested font families that are displayed wherever a choice is presented
-     * @defaultValue `['Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Times New Roman', 'Signika', 'Modesto Condensed']`
+     * @defaultValue `["Arial", "Courier", "Courier New", "Helvetica", "Signika", "Times", "Times New Roman", "Modesto Condensed"]`
      */
     fontFamilies: string[];
 
@@ -1546,6 +1537,12 @@ declare global {
         layerClass: LayerClass;
         group: keyof CONFIG['Canvas']['groups'];
       }
+
+      type LightAnimationFunction = (
+        this: PointSource,
+        dt: number,
+        properties?: { speed?: number; intensity?: number; reverse?: false }
+      ) => void;
     }
 
     namespace Cards {
@@ -1555,6 +1552,11 @@ declare global {
         src: string;
       }
     }
+
+    namespace Dice {
+      // eslint-disable-next-line @typescript-eslint/no-empty-interface
+      interface RollModes extends Record<foundry.CONST.DICE_ROLL_MODES, string> {}
+    }
   }
 
   const CONFIG: CONFIG;

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

@@ -1,3 +1,27 @@
+interface DragDropConfiguration {
+  /**
+   * The CSS selector used to target draggable elements.
+   */
+  dragSelector?: DragDrop['dragSelector'];
+
+  /**
+   * The CSS selector used to target viable drop targets.
+   */
+  dropSelector?: DragDrop['dropSelector'];
+
+  /**
+   * An object of permission test functions for each action
+   * @defaultValue `{}`
+   */
+  permissions?: DragDrop['permissions'];
+
+  /**
+   * An object of callback functions for each action
+   * @defaultValue `{}`
+   */
+  callbacks?: DragDrop['callbacks'];
+}
+
 /**
  * A controller class for managing drag and drop workflows within an Application instance.
  * The controller manages the following actions: dragstart, dragover, drop
@@ -16,16 +40,9 @@
  */
 declare class DragDrop {
   /**
-   * @param dragSelector - The CSS selector used to target draggable elements.
-   *                       (default: `undefined`)
-   * @param dropSelector - The CSS selector used to target viable drop targets.
-   *                       (default: `undefined`)
-   * @param permissions  - An object of permission test functions for each action
-   *                       (default: `{}`)
-   * @param callbacks    - An object of callback functions for each action
-   *                       (default: `{}`)
+   * @param options - (default: `{}`)
    */
-  constructor({ dragSelector, dropSelector, permissions, callbacks }?: DragDrop.Options);
+  constructor({ dragSelector, dropSelector, permissions, callbacks }?: DragDropConfiguration);
 
   /**
    * The HTML selector which identifies draggable elements
@@ -65,7 +82,7 @@ declare class DragDrop {
   callback(event: DragEvent, action: DragDrop.Action): void;
 
   /**
-   * Test whether the current user has permission to perform a step of the workflow
+   * Execute a callback function associated with a certain action in the workflow
    * @param action   - The action being attempted
    * @param selector - The selector being targeted
    * @returns Can the action be performed?
@@ -97,29 +114,5 @@ declare class DragDrop {
 }
 
 declare namespace DragDrop {
-  interface Options {
-    /**
-     * The CSS selector used to target draggable elements.
-     */
-    dragSelector?: DragDrop['dragSelector'];
-
-    /**
-     * The CSS selector used to target viable drop targets.
-     */
-    dropSelector?: DragDrop['dropSelector'];
-
-    /**
-     * An object of permission test functions for each action
-     * @defaultValue `{}`
-     */
-    permissions?: DragDrop['permissions'];
-
-    /**
-     * An object of callback functions for each action
-     * @defaultValue `{}`
-     */
-    callbacks?: DragDrop['callbacks'];
-  }
-
   type Action = 'dragstart' | 'dragover' | 'drop';
 }

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

@@ -507,72 +507,98 @@ declare global {
     }
 
     interface PackageData<T> {
-      type: 'world' | 'system' | 'module';
+      availability: number;
       data: T;
-      id: string;
-      path: string;
-      scripts: string[];
       esmodules: string[];
-      styles: string[];
+      id: string;
       languages: Language[];
+      locked: boolean;
       packs: {
-        name: string;
+        absPath: string;
+        /** @deprecated since V9 */
+        entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
         label: string;
+        name: string;
+        package: string;
         path: string;
         private: boolean;
-        entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
         system?: string;
-        absPath: string;
-        package: string;
+        type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
       };
-      locked: boolean;
-      availability: number;
+      scripts: string[];
+      styles: string[];
+      type: 'world' | 'system' | 'module';
       unavailable: boolean;
-      _systemUpdateCheckTime: number;
     }
 
-    interface WorldData<T> extends PackageData<T> {
-      type: 'world';
+    interface ModuleData<T> extends PackageData<T> {
+      active: boolean;
+      path: string;
+      type: 'module';
     }
 
     interface SystemData<T> extends PackageData<T> {
-      type: 'system';
+      _systemUpdateCheckTime: number;
+      documentTypes: {
+        [Key in
+          | foundry.CONST.DOCUMENT_TYPES
+          | 'ActiveEffect'
+          | 'Adventure'
+          | 'AmbientLight'
+          | 'AmbientSound'
+          | 'Card'
+          | 'Combatant'
+          | 'Drawing'
+          | 'FogExploration'
+          | 'MeasuredTemplate'
+          | 'Note'
+          | 'PlaylistSound'
+          | 'Setting'
+          | 'TableResult'
+          | 'Tile'
+          | 'Token'
+          | 'Wall']: string[];
+      };
+      model: {
+        Actor: Record<string, Record<string, unknown>>;
+        Cards: Record<string, Record<string, unknown>>;
+        Item: Record<string, Record<string, unknown>>;
+      };
+      path: string;
       template: {
         Actor?: {
           types: string[];
-          templates?: Partial<Record<string, unknown>>;
-        } & Partial<Record<string, unknown>>;
+          templates?: Record<string, unknown>;
+        } & Record<string, unknown>;
         Item?: {
           types: string[];
-          templates?: Partial<Record<string, unknown>>;
-        } & Partial<Record<string, unknown>>;
-      };
-      entityTypes: { [Key in foundry.CONST.DOCUMENT_TYPES | 'Setting' | 'FogExploration']: string[] };
-      model: {
-        Actor: Partial<Record<string, Partial<Record<string, unknown>>>>;
-        Item: Partial<Record<string, Partial<Record<string, unknown>>>>;
+          templates?: Record<string, unknown>;
+        } & Record<string, unknown>;
       };
+      type: 'system';
     }
 
-    interface ModuleData<T> extends PackageData<T> {
-      type: 'module';
-      active: boolean;
+    interface WorldData<T> extends PackageData<T> {
+      _systemUpdateCheckTime: number;
+      type: 'world';
     }
 
     type Data = {
-      userId: string;
-      /** @deprecated since V9 */
-      version: string;
-      world: WorldData<foundry.packages.WorldData>;
-      system: SystemData<foundry.packages.SystemData>;
-      modules: ModuleData<foundry.packages.ModuleData>[];
-      paused: boolean;
+      activeUsers: string[];
       addresses: {
         local: string;
         remote: string;
+        remoteIsAccessible: boolean;
+      };
+      coreUpdate: {
+        channel: unknown | null;
+        couldReachWebsite: boolean;
+        hasUpdate: boolean;
+        slowResponse: boolean;
+        version: unknown | null;
+        willDisableModules: boolean;
       };
       files: {
-        storages: ('public' | 'data' | 's3')[];
         s3?: {
           endpoint: {
             protocol: string;
@@ -584,28 +610,48 @@ declare global {
             href: string;
           };
           buckets: string[];
-        };
+        } | null;
+        storages: ('public' | 'data' | 's3')[];
       };
+      modules: ModuleData<foundry.packages.ModuleData>[];
       options: {
+        demo: boolean;
         language: string;
         port: number;
         routePrefix: string | null;
         updateChannel: string;
-        demo: boolean;
       };
-      activeUsers: string[];
       packs: {
-        name: string;
+        /** @deprecated since V9 */
+        entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
+        index: {
+          _id: string;
+          name: string;
+          type: string;
+        }[];
         label: string;
+        name: string;
+        package: string;
         path: string;
         private: boolean;
-        entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
         system?: string;
-        package: string;
-        index: { name: string; type: string; _id: string }[];
+        type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
+      }[];
+      paused: boolean;
+      release: {
+        build: number;
+        channel: 'Stable' | 'Testing' | 'Development' | 'Prototype';
+        download: string;
+        generation: string;
+        notes: string;
+        time: number;
       };
-      coreUpdate: string | null;
+      system: SystemData<foundry.packages.SystemData>;
       systemUpdate: string | null;
+      userId: string;
+      /** @deprecated since V9 */
+      version?: string;
+      world: WorldData<foundry.packages.WorldData>;
     } & {
       [DocumentType in
         | foundry.CONST.DOCUMENT_TYPES