@league-of-foundry-developers/foundry-vtt-types 0.8.9-8 → 9.242.0

package/src/foundry/foundry.js/rollTerms/mathTerm.d.ts

@@ -44,6 +44,9 @@ declare global {
 
     get expression(): string;
 
+    /** @override */
+    get isDeterministic(): boolean;
+
     protected _evaluateSync({ minimize, maximize }?: { minimize?: boolean; maximize?: boolean }): this;
 
     protected _evaluate({ minimize, maximize }?: { minimize?: boolean; maximize?: boolean }): Promise<this>;

package/src/foundry/foundry.js/rollTerms/parentheticalTerm.d.ts

@@ -22,6 +22,9 @@ declare class ParentheticalTerm extends RollTerm {
   /** An array of evaluated DiceTerm instances that should be bubbled up to the parent Roll */
   get dice(): DiceTerm[];
 
+  /** @override */
+  get isDeterministic(): boolean;
+
   /**
    * Construct a ParentheticalTerm from an Array of component terms which should be wrapped inside the parentheses.
    * @param terms - The array of terms to use as internal parts of the parenthetical

package/src/foundry/foundry.js/rollTerms/poolTerm.d.ts

@@ -177,11 +177,6 @@ declare global {
     countFailures(modifier: string): ReturnType<Die['countFailures']>;
   }
 
-  /**
-   * @deprecated since 0.8.1
-   */
-  const DicePool: typeof PoolTerm;
-
   namespace PoolTerm {
     /**
      * @remarks This interface is not defined by foundry itself. It only exists
@@ -209,6 +204,9 @@ interface PoolTermConstructorData {
    */
   terms?: string[];
 
+  /** @override */
+  get isDeterministic(): boolean;
+
   /**
    * @defaultValue `[]`
    */

package/src/foundry/foundry.js/rollTerms/stringTerm.d.ts

@@ -16,7 +16,10 @@ declare global {
 
     get total(): string;
 
-    evaluate(options?: Partial<RollTerm.EvaluationOptions>): never;
+    /** @override */
+    get isDeterministic(): boolean;
+
+    evaluate(options?: InexactPartial<RollTerm.EvaluationOptions>): never;
   }
 }
 

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

@@ -0,0 +1,19 @@
+/**
+ * A tool for culling the renderable state of objects which are outside the current viewport.
+ */
+declare class ScreenCulling {
+  constructor();
+
+  /**
+   * Toggle the renderable state of objects based on the current viewport rectangle
+   */
+  cull(rect: Rectangle): void;
+
+  /**
+   * Test whether rectangular bounds intersect
+   * @param rect   - The target rectangle (the screen)
+   * @param bounds - The reference rectangle (the object)
+   * @returns Do they intersect?
+   */
+  intersects(rect: Rectangle, bounds: Rectangle): boolean;
+}

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

@@ -84,7 +84,7 @@ declare namespace SearchFilter {
 
     /**
      * The initial value of the search query.
-     * @defaultValue `''`
+     * @defaultValue `""`
      */
     initial?: SearchFilter['query'];
 

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

@@ -1,5 +1,5 @@
 /**
- * I don't know what this will do yet
+ * TODO: Document Me
  */
 declare class SpecialEffect {
   constructor(parent: PIXI.Container, options?: DeepPartial<SpecialEffect.Options>);

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

@@ -6,7 +6,7 @@ declare class TextEditor {
    * Create a Rich Text Editor. The current implementation uses TinyMCE
    * @param options - Configuration options provided to the Editor init
    * @param content - Initial HTML or text content to populate the editor with
-   *                  (default: `''`)
+   *                  (default: `""`)
    * @returns The editor instance.
    */
   static create(options: TextEditor.Options, content: string): Promise<tinyMCE.Editor>;

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,9 +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,6 +29,7 @@ import './foundry.js/fonts';
 import './foundry.js/formDataExtended';
 import './foundry.js/game';
 import './foundry.js/gameTime';
+import './foundry.js/gamepadManager';
 import './foundry.js/globalVariables';
 import './foundry.js/handlebarsHelpers';
 import './foundry.js/hooks';
@@ -33,17 +38,37 @@ import './foundry.js/keyboardManager';
 import './foundry.js/localization';
 import './foundry.js/mersenneTwister';
 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';
@@ -53,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/types/utils.d.ts

@@ -2,10 +2,18 @@
  * Recursively sets keys of an object to optional. Used primarily for update methods
  * @internal
  */
-declare type DeepPartial<T> = {
+type DeepPartial<T> = {
   [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 
+/**
+ * Make all properties in T optional and explicitly allow `undefined`
+ * @internal
+ */
+type InexactPartial<T> = {
+  [P in keyof T]?: T[P] | undefined;
+};
+
 /**
  * References the constructor of type `T`
  * @internal
@@ -75,7 +83,7 @@ type Expanded<O> = O extends Record<string, unknown>
  * Union type of the types of the values in `T`
  * @internal
  */
-type ValueOf<T> = T extends Array<unknown> ? T[number] : T[keyof T];
+type ValueOf<T> = T extends Array<unknown> | ReadonlyArray<unknown> ? T[number] : T[keyof T];
 
 /**
  * Transforms a string to lowercase and the first character to uppercase.
@@ -96,7 +104,7 @@ type Titlecase<S extends string> = S extends `${infer A} ${infer B}`
  * @typeParam U - The type that will be merged into `T`.
  */
 type Merge<T, U> = T extends object
-  ? U extends Array<any>
+  ? U extends Array<any> | ReadonlyArray<any>
     ? U
     : U extends object
     ? {

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