@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/{foundry.js/pixi/containers/placeableObjects/ambientLight.d.ts → client/pixi/placeables/light.d.ts}

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -19,11 +19,9 @@ declare global {
      */
     controlIcon: ControlIcon | undefined;
 
-    /** @override */
-    static embeddedName: 'AmbientLight';
+    static override embeddedName: 'AmbientLight';
 
-    /** @override */
-    get bounds(): NormalizedRectangle;
+    override get bounds(): NormalizedRectangle;
 
     /**
      * A convenience accessor to the LightData configuration object
@@ -55,11 +53,9 @@ declare global {
      */
     get isVisible(): boolean;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
-    /** @override */
-    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
 
     /**
      * Draw the ControlIcon for the AmbientLight
@@ -67,8 +63,7 @@ declare global {
      */
     protected _drawControlIcon(): ControlIcon;
 
-    /** @override */
-    refresh(): this;
+    override refresh(): this;
 
     /**
      * Refresh the display of the ControlIcon for this AmbientLight source
@@ -86,40 +81,31 @@ declare global {
      */
     updateSource(options?: AmbientLight.UpdateSourceOptions | undefined): void;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.AmbientLightData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.AmbientLightData['_source']>,
       options?: DocumentModificationOptions,
       userId?: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /** @override */
-    protected _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
-    /** @override */
-    protected _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
-    /** @override */
-    protected _onClickRight(event: PIXI.InteractionEvent): Promise<this>;
+    protected override _onClickRight(event: PIXI.InteractionEvent): Promise<this>;
 
-    /** @override */
-    protected _onDragLeftStart(event: PIXI.InteractionEvent): void;
+    protected override _onDragLeftStart(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
+    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftCancel(event: MouseEvent): void;
+    protected override _onDragLeftCancel(event: MouseEvent): void;
   }
 
   namespace AmbientLight {

package/src/foundry/{foundry.js/pixi/containers/placeableObjects → client/pixi/placeables}/note.d.ts

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import { HoverInOptions } from '../placeableObject';
+import type { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import { HoverInOptions } from '../placeable';
 
 declare global {
   /**
@@ -7,11 +7,9 @@ declare global {
    * Each Note links to a JournalEntry document and represents its location on the map.
    */
   class Note extends PlaceableObject<InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>> {
-    /** @override */
-    static embeddedName: 'Note';
+    static override embeddedName: 'Note';
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * The associated JournalEntry which is described by this note
@@ -35,8 +33,7 @@ declare global {
      */
     get isVisible(): boolean;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
     /**
      * Draw the ControlIcon for the Map Note
@@ -53,25 +50,18 @@ declare global {
      */
     protected _getTextStyle(): PIXI.TextStyle;
 
-    /** @override */
-    refresh(): this;
+    override refresh(): this;
 
-    /** @override */
-    protected _onUpdate(changed: DeepPartial<foundry.data.NoteData['_source']>): void;
+    protected override _onUpdate(changed: DeepPartial<foundry.data.NoteData['_source']>): void;
 
-    /** @override */
-    protected _canHover(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): true;
+    protected override _canHover(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): true;
 
-    /** @override */
-    protected _canView(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): boolean;
+    protected override _canView(user: InstanceType<ConfiguredDocumentClassForName<'User'>>): boolean;
 
-    /** @override */
-    protected _onHoverIn(event: PIXI.InteractionEvent, options?: HoverInOptions): false | void;
+    protected override _onHoverIn(event: PIXI.InteractionEvent, options?: HoverInOptions): false | void;
 
-    /** @override */
-    protected _onHoverOut(event: PIXI.InteractionEvent): false | void;
+    protected override _onHoverOut(event: PIXI.InteractionEvent): false | void;
 
-    /** @override */
-    protected _onClickLeft2(event: PIXI.InteractionEvent): void;
+    protected override _onClickLeft2(event: PIXI.InteractionEvent): void;
   }
 }

package/src/foundry/{foundry.js/pixi/containers/placeableObjects/ambientSound.d.ts → client/pixi/placeables/sound.d.ts}

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -18,8 +18,7 @@ declare global {
      */
     source: SoundSource;
 
-    /** @override */
-    static embeddedName: 'AmbientSound';
+    static override embeddedName: 'AmbientSound';
 
     /**
      * Create a Sound used to play this AmbientSound object
@@ -32,8 +31,7 @@ declare global {
      */
     get isAudible(): boolean;
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * The named identified for the source object associated with this ambient sound
@@ -53,14 +51,11 @@ declare global {
      */
     sync(isAudible: boolean, volume: number, options?: Partial<AmbientSound.SyncOptions>): void;
 
-    /** @override */
-    clear(): this;
+    override clear(): this;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
-    /** @override */
-    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
 
     /**
      * Draw the graphical preview of the audio source area of effect
@@ -74,8 +69,7 @@ declare global {
      */
     protected _drawControlIcon(): ControlIcon;
 
-    /** @override */
-    refresh(): this;
+    override refresh(): this;
 
     /**
      * Refresh the display of the ControlIcon for this AmbientSound source
@@ -88,34 +82,27 @@ declare global {
      */
     updateSource(options?: AmbientSound.UpdateSourceOptions | undefined): void;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.AmbientSoundData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.AmbientSoundData['_source']>,
       options?: DocumentModificationOptions,
       userId?: string
     ): void;
 
-    /** @override */
-    protected _onDelete(...args: Parameters<PlaceableObject['_onDelete']>): void;
+    protected override _onDelete(...args: Parameters<PlaceableObject['_onDelete']>): void;
 
-    /** @override */
-    protected _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canHUD(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
-    /** @override */
-    protected _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
-    /** @override */
-    protected _onClickRight(event: PIXI.InteractionEvent): void;
+    protected override _onClickRight(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
+    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
   }
 
   namespace AmbientSound {

package/src/foundry/client/pixi/placeables/template.d.ts

@@ -0,0 +1,153 @@
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+
+declare global {
+  /**
+   * 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>>
+  > {
+    /**
+     * 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 | undefined;
+
+    /**
+     * The template graphics
+     * @defaultValue `undefined`
+     */
+    template: PIXI.Graphics | undefined;
+
+    /**
+     * The UI frame container which depicts Token metadata and status, displayed in the ControlsLayer.
+     * @defaultValue `new ObjectHUD(this)`
+     */
+    hud: MeasuredTemplate.ObjectHUD;
+
+    /**
+     * Internal property used to configure the control border thickness
+     * @defaultValue `3`
+     * @internal
+     */
+    protected _borderThickness: number;
+
+    static override embeddedName: 'MeasuredTemplate';
+
+    override get bounds(): Rectangle;
+
+    /**
+     * A convenience accessor for the border color as a numeric hex code
+     */
+    get borderColor(): string | number;
+
+    /**
+     * A convenience accessor for the fill color as a numeric hex code
+     */
+    get fillColor(): string | number;
+
+    /**
+     * A flag for whether the current User has full ownership over the MeasuredTemplate document.
+     */
+    get owner(): boolean;
+
+    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;
+
+    override refresh(): this;
+
+    /**
+     * 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;
+
+    /**
+     * Update the displayed ruler tooltip text
+     * @internal
+     */
+    protected _refreshRulerText(): void;
+
+    /**
+     * Highlight the grid squares which should be shown under the area of effect
+     */
+    highlightGrid(): void;
+
+    override rotate(angle: number, snap: number): Promise<this>;
+
+    protected override _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+
+    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+
+    protected override _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+
+    protected override _onUpdate(
+      data: DeepPartial<InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>['data']['_source']>,
+      options?: DocumentModificationOptions,
+      userId?: string
+    ): void;
+
+    protected override _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 → client/pixi/placeables}/tile.d.ts

@@ -1,6 +1,6 @@
-import type { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
-import type { TileDataConstructorData } from '../../../../common/data/data.mjs/tileData';
+import type { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { TileDataConstructorData } from '../../../common/data/data.mjs/tileData';
 
 declare global {
   /**
@@ -70,16 +70,20 @@ declare global {
      */
     occluded: boolean;
 
-    /** @override */
-    static embeddedName: 'Tile';
+    /**
+     * A flag which tracks if the Tile is currently playing
+     * @defaultValue `false`
+     */
+    playing: boolean;
+
+    static override embeddedName: 'Tile';
 
     /**
      * Get the native aspect ratio of the base texture for the Tile sprite
      */
     get aspectRatio(): number;
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * The HTML source element for the primary Tile texture
@@ -96,16 +100,19 @@ declare global {
      */
     get isRoof(): boolean;
 
-    /** @override */
-    draw(): Promise<this>;
+    /**
+     * The effective volume at which this Tile should be playing, including the global ambient volume modifier
+     */
+    get volume(): number;
 
-    /** @override */
-    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+    override draw(): Promise<this>;
+
+    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
 
     /**
-     * @param options - (default: `{}`)
-     * @override */
-    refresh(options?: Tile.RefreshOptions | undefined): this;
+     * @param options - (default: `{}`) */
+
+    override refresh(options?: Tile.RefreshOptions | undefined): this;
 
     /**
      * Refresh the display of the Tile border
@@ -189,36 +196,27 @@ declare global {
      */
     protected _createOcclusionFilter(): AbstractBaseMaskFilter;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.TileData['_source']>,
       options?: DocumentModificationOptions,
       userId?: string
     ): Promise<this> | void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /** @override */
-    activateListeners(): void;
+    override activateListeners(): void;
 
-    /** @override */
-    protected _canConfigure(user: User, event?: any): boolean;
+    protected override _canConfigure(user: User, event?: any): boolean;
 
-    /** @override */
-    protected _onClickLeft2(event: PIXI.InteractionEvent): void;
+    protected override _onClickLeft2(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftStart(event: PIXI.InteractionEvent): void;
+    protected override _onDragLeftStart(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
+    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<unknown>;
+    protected override _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<unknown>;
 
-    /** @override */
-    protected _onDragLeftCancel(event: MouseEvent): void;
+    protected override _onDragLeftCancel(event: MouseEvent): void;
 
     /**
      * Handle mouse-over event on a control handle