@league-of-foundry-developers/foundry-vtt-types 9.255.0 → 9.255.3

package/src/foundry/foundry.js/pixi/containers/placeableObject.d.ts

@@ -4,7 +4,7 @@ import { Document } from '../../../common/abstract/module.mjs';
 
 declare global {
   /**
-   * An Abstract Base Class which defines a Placeable Object which represents an Entity placed on the Canvas
+   * An Abstract Base Class which defines a Placeable Object which represents a Document placed on the Canvas
    */
   abstract class PlaceableObject<
     D extends Document<any, InstanceType<ConfiguredDocumentClass<typeof Scene>>> = Document<
@@ -68,8 +68,8 @@ declare global {
     protected _hover: boolean;
 
     /**
-     * Identify the official EmbeddedEntity name for this PlaceableObject class
-     * @remarks This getter is abstract in {@link PlaceableObject}.
+     * Identify the official Document name for this PlaceableObject class
+     * @remarks This is abstract in {@link PlaceableObject}.
      */
     static embeddedName: string;
 
@@ -77,7 +77,7 @@ declare global {
      * The bounding box for this PlaceableObject.
      * This is required if the layer uses a Quadtree, otherwise it is optional
      */
-    get bounds(): Rectangle;
+    abstract get bounds(): Rectangle;
 
     /**
      * The central coordinate pair of the placeable object based on it's own width and height
@@ -106,8 +106,8 @@ declare global {
     get los(): this['vision']['los'];
 
     /**
-     * A Form Application which is used to configure the properties of this Placeable Object or the EmbeddedEntity
-     * it represents.
+     * A Form Application which is used to configure the properties of this Placeable Object or the Document it
+     * represents.
      */
     get sheet(): 'sheet' extends keyof D ? D['sheet'] : FormApplication | null;
 
@@ -151,7 +151,7 @@ declare global {
     protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to create the underlying Embedded Entity?
+     * Does the User have permission to create the underlying Document?
      * @param event - (unused)
      */
     protected _canCreate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -169,13 +169,13 @@ declare global {
     protected _canHover(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to update the underlying Embedded Entity?
+     * Does the User have permission to update the underlying Document?
      * @param event - (unused)
      */
     protected _canUpdate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to delete the underlying Embedded Entity?
+     * Does the User have permission to delete the underlying Document?
      * @param event - (unused)
      */
     protected _canDelete(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -378,52 +378,6 @@ declare global {
      * @param event - The triggering mouse click event
      */
     protected _onDragLeftCancel(event: MouseEvent): void;
-
-    /**
-     * @deprecated since 0.8.0
-     * @param options - (default: `{}`)
-     */
-    static create(
-      data:
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1][],
-      options?: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    update(data: Parameters<D['update']>[0], options: Parameters<D['update']>[1]): ReturnType<D['update']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    delete(options: Parameters<D['delete']>[0]): ReturnType<D['delete']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    getFlag(scope: string, key: string): ReturnType<D['getFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    setFlag(scope: string, key: string, value: unknown): ReturnType<D['setFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    unsetFlag(scope: string, key: string): ReturnType<D['unsetFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get uuid(): string;
-
-    /**
-     * @deprecated since 0.8.2
-     */
-    static get layer(): PlaceablesLayer<any>;
   }
 
   namespace PlaceableObject {

package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientLight.d.ts

@@ -11,7 +11,7 @@ declare global {
     /**
      * A reference to the PointSource object which defines this light source area of effect
      */
-    source: PointSource;
+    source: LightSource;
 
     /**
      * A reference to the ControlIcon used to configure this light
@@ -25,6 +25,11 @@ declare global {
     /** @override */
     get bounds(): NormalizedRectangle;
 
+    /**
+     * A convenience accessor to the LightData configuration object
+     */
+    get config(): foundry.data.LightData;
+
     /**
      * Test whether a specific AmbientLight source provides global illumination
      */
@@ -53,6 +58,9 @@ declare global {
     /** @override */
     draw(): Promise<this>;
 
+    /** @override */
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
     /**
      * Draw the ControlIcon for the AmbientLight
      * @internal
@@ -74,12 +82,9 @@ declare global {
 
     /**
      * Update the source object associated with this light
-     * @param defer   - Defer refreshing the LightingLayer to manually call that refresh later.
-     *                  (default: `false`)
-     * @param deleted - Indicate that this light source has been deleted.
-     *                  (default: `false`)
+     * @param options - (default: `{}}`)
      */
-    updateSource({ defer, deleted }?: { defer?: boolean; deleted?: boolean }): null | void;
+    updateSource(options?: AmbientLight.UpdateSourceOptions | undefined): void;
 
     /** @override */
     protected _onCreate(
@@ -116,4 +121,20 @@ declare global {
     /** @override */
     protected _onDragLeftCancel(event: MouseEvent): void;
   }
+
+  namespace AmbientLight {
+    interface UpdateSourceOptions {
+      /**
+       * Defer refreshing the LightingLayer to manually call that refresh later.
+       * @defaultValue `false`
+       */
+      defer?: boolean | undefined;
+
+      /**
+       * Indicate that this light source has been deleted.
+       * @defaultValue `false`
+       */
+      deleted?: boolean | undefined;
+    }
+  }
 }

package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientSound.d.ts

@@ -13,6 +13,11 @@ declare global {
      */
     sound: Sound | null;
 
+    /**
+     * A SoundSource object which manages the area of effect for this ambient sound
+     */
+    source: SoundSource;
+
     /** @override */
     static embeddedName: 'AmbientSound';
 
@@ -27,10 +32,13 @@ declare global {
      */
     get isAudible(): boolean;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
-     * A convenience accessor for the sound type
+     * The named identified for the source object associated with this ambient sound
      */
-    get type(): 'l' | 'g';
+    get sourceId(): string;
 
     /**
      * A convenience accessor for the sound radius in pixels
@@ -51,6 +59,9 @@ declare global {
     /** @override */
     draw(): Promise<this>;
 
+    /** @override */
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
     /**
      * Draw the graphical preview of the audio source area of effect
      * @internal
@@ -73,9 +84,9 @@ declare global {
 
     /**
      * Compute the field-of-vision for an object, determining its effective line-of-sight and field-of-vision polygons
-     * @returns An object containing the rays, LOS polygon, and FOV polygon for the light
+     * @param options - (default: `{}`)
      */
-    updateSource(): { rays: null; los: null; fov: PIXI.Circle } | ReturnType<WallsLayer['computePolygon']>;
+    updateSource(options?: AmbientSound.UpdateSourceOptions | undefined): void;
 
     /** @override */
     protected _onCreate(
@@ -115,5 +126,19 @@ declare global {
        */
       fade: number;
     }
+
+    interface UpdateSourceOptions {
+      /**
+       * Defer refreshing the SoundsLayer to manually call that refresh later.
+       * @defaultValue `false`
+       */
+      defer?: boolean | undefined;
+
+      /**
+       * Indicate that this SoundSource has been deleted.
+       * @defaultValue `false`
+       */
+      deleted?: boolean | undefined;
+    }
   }
 }

package/src/foundry/foundry.js/pixi/containers/placeableObjects/drawing.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
 
 declare global {
@@ -40,18 +40,25 @@ declare global {
     /**
      * Internal timestamp for the previous freehand draw time, to limit sampling
      * @defaultValue `0`
+     * @internal
      */
     protected _drawTime: number;
+
+    /**
+     * @defaultValue `0`
+     * @internal
+     */
     protected _sampleTime: number;
 
     /**
      * Internal flag for the permanent points of the polygon
      * @defaultValue `foundry.utils.deepClone(this.data.points || [])`
+     * @internal
      */
     protected _fixedPoints: Array<[x: number, y: number]>;
 
     /** @override */
-    static get embeddedName(): 'Drawing';
+    static embeddedName: 'Drawing';
 
     /**
      * The rate at which points are sampled (in milliseconds) during a freehand drawing workflow
@@ -59,6 +66,9 @@ declare global {
      */
     static FREEHAND_SAMPLE_RATE: number;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A Boolean flag for whether or not the Drawing utilizes a tiled texture background
      */
@@ -74,6 +84,7 @@ declare global {
 
     /**
      * Clean the drawing data to constrain its allowed position
+     * @internal
      */
     protected _cleanData(): void;
 
@@ -84,11 +95,13 @@ declare global {
 
     /**
      * Create elements for the foreground text
+     * @internal
      */
     protected _createText(): PreciseText;
 
     /**
      * Create elements for the Drawing border and handles
+     * @internal
      */
     protected _createFrame(): void;
 
@@ -97,21 +110,25 @@ declare global {
 
     /**
      * Draw rectangular shapes
+     * @internal
      */
     protected _drawRectangle(): void;
 
     /**
      * Draw ellipsoid shapes
+     * @internal
      */
     protected _drawEllipse(): void;
 
     /**
      * Draw polygonal shapes
+     * @internal
      */
     protected _drawPolygon(): void;
 
     /**
      * Draw freehand shapes with bezier spline smoothing
+     * @internal
      */
     protected _drawFreehand(): void;
 
@@ -122,6 +139,7 @@ declare global {
      * @param previous - The prior point
      * @param point    - The current point
      * @param next     - The next point
+     * @internal
      */
     protected _getBezierControlPoints(
       factor: number,
@@ -141,17 +159,20 @@ declare global {
 
     /**
      * Refresh the boundary frame which outlines the Drawing shape
+     * @internal
      */
     protected _refreshFrame({ x, y, width, height }: Rectangle): void;
 
     /**
      * Add a new polygon point to the drawing, ensuring it differs from the last one
      * @param temporary - (default: `true`)
+     * @internal
      */
     protected _addPoint(position: Point, temporary?: boolean): void;
 
     /**
      * Remove the last fixed point from the polygon
+     * @internal
      */
     protected _removePoint(): void;
 
@@ -166,13 +187,9 @@ declare global {
 
     /**
      * Handle text entry in an active text tool
+     * @internal
      */
-    protected _onDrawingTextKeydown(
-      event: KeyboardEvent
-    ):
-      | ReturnType<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>['update']>
-      | ReturnType<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>['delete']>
-      | void;
+    protected _onDrawingTextKeydown(event: KeyboardEvent): void;
 
     /** @override */
     protected _onUpdate(data: DeepPartial<foundry.data.DrawingData['_source']>): void;
@@ -181,20 +198,21 @@ declare global {
      * @override
      * @param event - unused
      */
-    protected _canControl(user: User, event?: any): boolean;
+    protected _canControl(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
     /**
      * @override
      * @param user  - unused
      * @param event - unused
      */
-    protected _canConfigure(user: User, event?: any): boolean;
+    protected _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
     /** @override */
     activateListeners(): void;
 
     /**
      * Handle mouse movement which modifies the dimensions of the drawn shape
+     * @internal
      */
     protected _onMouseDraw(event: PIXI.InteractionEvent): void;
 
@@ -213,35 +231,41 @@ declare global {
     /**
      * Handle mouse-over event on a control handle
      * @param event - The mouseover event
+     * @internal
      */
     protected _onHandleHoverIn(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mouse-out event on a control handle
      * @param event - The mouseout event
+     * @internal
      */
     protected _onHandleHoverOut(event: PIXI.InteractionEvent): void;
 
     /**
      * When we start a drag event - create a preview copy of the Tile for re-positioning
      * @param event - The mousedown event
+     * @internal
      */
     protected _onHandleMouseDown(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle the beginning of a drag event on a resize handle
+     * @internal
      */
     protected _onHandleDragStart(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mousemove while dragging a tile scale handler
      * @param event - The mousemove event
+     * @internal
      */
     protected _onHandleDragMove(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mouseup after dragging a tile scale handler
      * @param event - The mouseup event
+     * @internal
      */
     protected _onHandleDragDrop(
       event: PIXI.InteractionEvent
@@ -249,6 +273,7 @@ declare global {
 
     /**
      * Handle cancellation of a drag event for one of the resizing handles
+     * @internal
      */
     protected _onHandleDragCancel(event: PIXI.InteractionEvent): void;
 
@@ -257,6 +282,7 @@ declare global {
      * @param original - The original drawing data
      * @param dx       - The pixel distance dragged in the horizontal direction
      * @param dy       - The pixel distance dragged in the vertical direction
+     * @internal
      */
     protected _rescaleDimensions(
       original: Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'points' | 'width' | 'height'>,
@@ -269,19 +295,10 @@ declare global {
      * @param data - The Drawing data pending update
      * @returns The adjusted data
      * @remarks This is intentionally public because it is called by the DrawingsLayer
+     * @internal
      */
     static normalizeShape(
       data: Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'width' | 'height' | 'points'>
     ): Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'width' | 'height' | 'points'>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get author(): InstanceType<ConfiguredDocumentClass<typeof User>>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get owner(): boolean;
   }
 }

package/src/foundry/foundry.js/pixi/containers/placeableObjects/measuredTemplate.d.ts

@@ -3,36 +3,49 @@ import { DocumentModificationOptions } from '../../../../common/abstract/documen
 
 declare global {
   /**
-   * A MeasuredTemplate is an implementation of PlaceableObject which represents an area of the canvas grid which is
-   * covered by some effect.
+   * A type of Placeable Object which highlights an area of the grid as covered by some area of effect.
+   * @see {@link MeasuredTemplateDocument}
+   * @see {@link TemplateLayer}
    */
   class MeasuredTemplate extends PlaceableObject<
     InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>
   > {
-    constructor(document: InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>);
-
-    controlIcon: ControlIcon | null;
-    template: PIXI.Graphics | null;
-    ruler: PreciseText | null;
+    /**
+     * The geometry shape used for testing point intersection
+     * @defaultValue `undefined`
+     */
+    shape: PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle | undefined;
 
     /**
      * The tiling texture used for this template, if any
      */
-    texture: PIXI.Texture | null;
+    texture: PIXI.Texture | undefined;
+
+    /**
+     * The template graphics
+     * @defaultValue `undefined`
+     */
+    template: PIXI.Graphics | undefined;
 
     /**
-     * The template shape used for testing point intersection
+     * The UI frame container which depicts Token metadata and status, displayed in the ControlsLayer.
+     * @defaultValue `new ObjectHUD(this)`
      */
-    shape: PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle;
+    hud: MeasuredTemplate.ObjectHUD;
 
     /**
      * Internal property used to configure the control border thickness
+     * @defaultValue `3`
+     * @internal
      */
     protected _borderThickness: number;
 
     /** @override */
     static embeddedName: 'MeasuredTemplate';
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A convenience accessor for the border color as a numeric hex code
      */
@@ -51,13 +64,24 @@ declare global {
     /** @override */
     draw(): Promise<this>;
 
+    /** @override */
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
+    /**
+     * Draw the HUD container which provides an interface for managing this template
+     * @internal
+     */
+    protected _drawHUD(): MeasuredTemplate.InitializedObjectHUD;
+
     /**
      * Draw the ControlIcon for the MeasuredTemplate
+     * @internal
      */
     protected _drawControlIcon(): ControlIcon;
 
     /**
      * Draw the Text label used for the MeasuredTemplate
+     * @internal
      */
     protected _drawRulerText(): PreciseText;
 
@@ -66,31 +90,31 @@ declare global {
 
     /**
      * Get a Circular area of effect given a radius of effect
+     * @internal
      */
     protected _getCircleShape(distance: number): PIXI.Circle;
 
     /**
      * Get a Conical area of effect given a direction, angle, and distance
+     * @internal
      */
     protected _getConeShape(direction: number, angle: number, distance: number): PIXI.Polygon;
 
     /**
      * Get a Rectangular area of effect given a width and height
+     * @internal
      */
     protected _getRectShape(direction: number, distance: number): NormalizedRectangle;
 
     /**
      * Get a rotated Rectangular area of effect given a width, height, and direction
+     * @internal
      */
     protected _getRayShape(direction: number, distance: number, width: number): PIXI.Polygon;
 
-    /**
-     * Draw the rotation control handle and assign event listeners
-     */
-    protected _drawRotationHandle(radius: number): void;
-
     /**
      * Update the displayed ruler tooltip text
+     * @internal
      */
     protected _refreshRulerText(): void;
 
@@ -121,4 +145,20 @@ declare global {
     /** @override */
     protected _onDelete(options: DocumentModificationOptions, userId: string): void;
   }
+
+  namespace MeasuredTemplate {
+    interface ObjectHUD extends globalThis.ObjectHUD {
+      /**
+       * Template control icon
+       */
+      icon?: ControlIcon;
+
+      /**
+       * Ruler text tooltip
+       */
+      ruler?: PreciseText;
+    }
+
+    type InitializedObjectHUD = RequiredProps<ObjectHUD, 'icon' | 'ruler'>;
+  }
 }

package/src/foundry/foundry.js/pixi/containers/placeableObjects/note.d.ts

@@ -4,11 +4,14 @@ import { HoverInOptions } from '../placeableObject';
 declare global {
   /**
    * A Note is an implementation of PlaceableObject which represents an annotated location within the Scene.
-   * Each Note links to a JournalEntry entity and represents it's location on the map.
+   * Each Note links to a JournalEntry document and represents its location on the map.
    */
   class Note extends PlaceableObject<InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>> {
     /** @override */
-    static get embeddedName(): 'Note';
+    static embeddedName: 'Note';
+
+    /** @override */
+    get bounds(): Rectangle;
 
     /**
      * The associated JournalEntry which is described by this note
@@ -25,6 +28,13 @@ declare global {
      */
     get size(): number;
 
+    /**
+     * Determine whether the Note is visible to the current user based on their perspective of the Scene.
+     * Visibility depends on permission to the underlying journal entry, as well as the perspective of controlled Tokens.
+     * If Token Vision is required, the user must have a token with vision over the note to see it.
+     */
+    get isVisible(): boolean;
+
     /** @override */
     draw(): Promise<this>;