@league-of-foundry-developers/foundry-vtt-types 9.238.1 → 9.249.1

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/playlists.d.ts

@@ -1,12 +1,12 @@
 import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import type { SceneDataConstructorData } from '../../../../common/data/data.mjs/sceneData.js';
+import type { SceneDataConstructorData } from '../../../../common/data/data.mjs/sceneData';
 
 declare global {
   /**
    * The singleton collection of Playlist documents which exist within the active World.
    * This Collection is accessible within the Game object as game.playlists.
    *
-   * @see {@link Playlist} The Playlist entity
+   * @see {@link Playlist} The Playlist document
    * @see {@link PlaylistDirectory} The PlaylistDirectory sidebar directory
    */
   class Playlists extends WorldCollection<typeof foundry.documents.BasePlaylist, 'Playlists'> {
@@ -20,7 +20,7 @@ declare global {
     static documentName: 'Playlist';
 
     /**
-     * Return the subset of Playlist entities which are currently playing
+     * Return the subset of Playlist documents which are currently playing
      */
     get playing(): ReturnType<this['filter']>;
 
@@ -30,8 +30,8 @@ declare global {
     initialize(): void;
 
     /**
-     * Handle changes to a Scene to determine whether to trigger changes to Playlist entities.
-     * @param scene - The Scene entity being updated
+     * Handle changes to a Scene to determine whether to trigger changes to Playlist documents.
+     * @param scene - The Scene document being updated
      * @param data  - The incremental update data
      */
     protected _onChangeScene(

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/rollTables.d.ts

@@ -13,7 +13,7 @@ declare class RollTables extends WorldCollection<typeof foundry.documents.BaseRo
   get directory(): typeof ui['tables'];
 
   /**
-   * Register world settings related to RollTable entities
+   * Register world settings related to RollTable documents
    */
   static registerSettings(): void;
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/scenes.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Scene documents which exist within the active World.
    * This Collection is accessible within the Game object as game.scenes.
    *
-   * @see {@link Scene} The Scene entity
+   * @see {@link Scene} The Scene document
    * @see {@link SceneDirectory} The SceneDirectory sidebar directory
    */
   class Scenes extends WorldCollection<typeof foundry.documents.BaseScene, 'Scenes'> {
@@ -54,7 +54,8 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
       '_id' | 'folder'

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/users.d.ts

@@ -5,19 +5,21 @@ declare global {
    * The singleton collection of User documents which exist within the active World.
    * This Collection is accessible within the Game object as game.users.
    *
-   * @see {@link User} The User entity
+   * @see {@link User} The User document
    */
   class Users extends WorldCollection<typeof foundry.documents.BaseUser, 'Users'> {
     constructor(data?: foundry.data.UserData['_source'][]);
 
     /**
-     * The User entity of the currently connected user
+     * The User document of the currently connected user
      * @defaultValue `null`
      */
     current: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>> | null;
 
     /**
-     * Initialize the Map object and all its contained entities
+     * Initialize the Map object and all its contained documents
+     * @override
+     * @internal
      */
     protected _initialize(): void;
 
@@ -36,7 +38,8 @@ declare global {
      * Handle receipt of activity data from another User connected to the Game session
      * @param userId       - The User id who generated the activity data
      * @param activityData - The object of activity data
+     *                       (default: `{}`)
      */
-    protected static _handleUserActivity(userId: string, activityData?: User.ActivityData): void;
+    protected static _handleUserActivity(userId: string, activityData?: ActivityData | undefined): void;
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/worldSettings.d.ts

@@ -9,10 +9,10 @@ declare class WorldSettings extends WorldCollection<typeof foundry.documents.Bas
   static documentName: 'Setting';
 
   /** @override */
-  get directory(): null;
+  get directory(): undefined;
 
   /**
-   * Return the Setting document with the given key.
+   * Return the Setting or Keybind document with the given key.
    * @param key - The setting key
    * @returns The Setting.
    */

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

@@ -0,0 +1,60 @@
+/**
+ * An object containing the result of a collision test.
+ * @internal
+ */
+declare class CollisionResult {
+  constructor(values?: {
+    target?: PolygonVertex | null;
+    collisions?: PolygonVertex[];
+    cwEdges?: EdgeSet;
+    ccwEdges?: EdgeSet;
+    isBehind?: boolean;
+    isLimited?: boolean;
+    isRequired?: boolean;
+    wasLimited?: boolean;
+  });
+
+  /**
+   * The vertex that was the target of this result
+   * @defaultValue `null`
+   */
+  target: PolygonVertex | null;
+
+  /**
+   * The array of collision points which apply to this result
+   * @defaultValue `[]`
+   */
+  collisions: PolygonVertex[];
+
+  /**
+   * The set of edges connected to the target vertex that continue clockwise
+   * @defaultValue `new Set()`
+   */
+  cwEdges: EdgeSet;
+
+  /**
+   * The set of edges connected to the target vertex that continue counter-clockwise
+   * @defaultValue `new Set()`
+   */
+  ccwEdges: EdgeSet;
+
+  /**
+   * Is the target vertex for this result behind some closer active edge?
+   */
+  isBehind: boolean | undefined;
+
+  /**
+   * Does the target vertex for this result impose a limited collision?
+   */
+  isLimited: boolean | undefined;
+
+  /**
+   * Is this result required due to a limited angle?
+   */
+  isRequired: boolean | undefined;
+
+  /**
+   * Has the set of collisions for this result encountered a limited edge?
+   */
+  wasLimited: boolean | undefined;
+}

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';
 }