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

package/src/foundry/{foundry.js/pixi/containers/placeableObject.d.ts → client/pixi/placeable.d.ts}

@@ -1,6 +1,6 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-import { Document } from '../../../common/abstract/module.mjs';
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { Document } from '../../common/abstract/module.mjs';
 
 declare global {
   /**
@@ -124,59 +124,46 @@ declare global {
 
     /**
      * Can the User access the HUD for this Placeable Object?
-     * @param user  - (unused)
-     * @param event - (unused)
      */
     protected _canHUD(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to configure the Placeable Object?
-     * @param user  - (unused)
-     * @param event - (unused)
      */
     protected _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to control the Placeable Object?
-     * @param user  - (unused)
-     * @param event - (unused)
      */
     protected _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to view details of the Placeable Object?
-     * @param user  - (unused)
-     * @param event - (unused)
      */
     protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to create the underlying Document?
-     * @param event - (unused)
      */
     protected _canCreate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to drag this Placeable Object?
-     * @param event - (unused)
      */
     protected _canDrag(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * Does the User have permission to hover on this Placeable Object?
-     * @param event - (unused)
      */
     protected _canHover(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
      * 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 Document?
-     * @param event - (unused)
      */
     protected _canDelete(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
@@ -195,8 +182,7 @@ declare global {
      */
     clone(): this;
 
-    /** @override */
-    destroy(options?: Parameters<PIXI.Container['destroy']>[0]): void;
+    override destroy(options?: Parameters<PIXI.Container['destroy']>[0]): void;
 
     /**
      * Draw the placeable object into its parent container
@@ -213,17 +199,11 @@ declare global {
 
     /**
      * Register pending canvas operations which should occur after a new PlaceableObject of this type is created
-     * @param data    - (unused)
-     * @param options - (unused)
-     * @param userId  - (unused)
-     * @remarks Second variant has been added because of `Token._onCreate()`
      */
     protected _onCreate(data: D['data']['_source'], options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Define additional steps taken when an existing placeable object of this type is updated with new data
-     * @param options - (unused)
-     * @param userId  - (unused)
      * @remarks Called without options and userId in Drowing._onUpdate
      */
     protected _onUpdate(
@@ -234,8 +214,6 @@ declare global {
 
     /**
      * Define additional steps taken when an existing placeable object of this type is deleted
-     * @param options - (unused)
-     * @param userId  - (unused)
      */
     protected _onDelete(options: DocumentModificationOptions, userId: string): void;
 
@@ -250,7 +228,6 @@ declare global {
     /**
      * Additional events which trigger once control of the object is established
      * @param options - Optional parameters which apply for specific implementations
-     *                  (unused)
      */
     protected _onControl(options?: PlaceableObject.ControlOptions): void;
 
@@ -265,7 +242,6 @@ declare global {
     /**
      * Additional events which trigger once control of the object is released
      * @param options - Options which modify the releasing workflow
-     *                  (unused)
      */
     protected _onRelease(options?: PlaceableObject.ReleaseOptions): void;
 

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

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -57,8 +57,7 @@ declare global {
      */
     protected _fixedPoints: Array<[x: number, y: number]>;
 
-    /** @override */
-    static embeddedName: 'Drawing';
+    static override embeddedName: 'Drawing';
 
     /**
      * The rate at which points are sampled (in milliseconds) during a freehand drawing workflow
@@ -66,8 +65,7 @@ declare global {
      */
     static FREEHAND_SAMPLE_RATE: number;
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * A Boolean flag for whether or not the Drawing utilizes a tiled texture background
@@ -79,8 +77,7 @@ declare global {
      */
     get isPolygon(): boolean;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
     /**
      * Clean the drawing data to constrain its allowed position
@@ -105,8 +102,7 @@ declare global {
      */
     protected _createFrame(): void;
 
-    /** @override */
-    refresh(): void;
+    override refresh(): void;
 
     /**
      * Draw rectangular shapes
@@ -176,14 +172,11 @@ declare global {
      */
     protected _removePoint(): void;
 
-    /** @override */
-    protected _onControl(options: PlaceableObject.ControlOptions & { isNew?: boolean }): void;
+    protected override _onControl(options: PlaceableObject.ControlOptions & { isNew?: boolean }): void;
 
-    /** @override */
-    protected _onRelease(options: PlaceableObject.ReleaseOptions): void;
+    protected override _onRelease(options: PlaceableObject.ReleaseOptions): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Handle text entry in an active text tool
@@ -191,24 +184,20 @@ declare global {
      */
     protected _onDrawingTextKeydown(event: KeyboardEvent): void;
 
-    /** @override */
-    protected _onUpdate(data: DeepPartial<foundry.data.DrawingData['_source']>): void;
+    protected override _onUpdate(data: DeepPartial<foundry.data.DrawingData['_source']>): void;
 
     /**
-     * @override
      * @param event - unused
      */
-    protected _canControl(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canControl(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
     /**
-     * @override
      * @param user  - unused
      * @param event - unused
      */
-    protected _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
+    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
-    /** @override */
-    activateListeners(): void;
+    override activateListeners(): void;
 
     /**
      * Handle mouse movement which modifies the dimensions of the drawn shape
@@ -216,17 +205,13 @@ declare global {
      */
     protected _onMouseDraw(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

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

@@ -1,8 +1,8 @@
-import './ambientLight';
-import './ambientSound';
 import './drawing';
-import './measuredTemplate';
+import './light';
 import './note';
+import './sound';
+import './template';
 import './tile';
 import './token';
 import './wall';

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/{foundry.js/pixi/containers/placeableObjects/measuredTemplate.d.ts → client/pixi/placeables/template.d.ts}

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -40,11 +40,9 @@ declare global {
      */
     protected _borderThickness: number;
 
-    /** @override */
-    static embeddedName: 'MeasuredTemplate';
+    static override embeddedName: 'MeasuredTemplate';
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * A convenience accessor for the border color as a numeric hex code
@@ -61,11 +59,9 @@ declare global {
      */
     get owner(): 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 HUD container which provides an interface for managing this template
@@ -85,8 +81,7 @@ declare global {
      */
     protected _drawRulerText(): PreciseText;
 
-    /** @override */
-    refresh(): this;
+    override refresh(): this;
 
     /**
      * Get a Circular area of effect given a radius of effect
@@ -123,27 +118,21 @@ declare global {
      */
     highlightGrid(): void;
 
-    /** @override */
-    rotate(angle: number, snap: number): Promise<this>;
+    override rotate(angle: number, snap: number): Promise<this>;
 
-    /** @override */
-    protected _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+    protected override _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
-    /** @override */
-    protected _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+    protected override _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
-    /** @override */
-    protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+    protected override _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>['data']['_source']>,
       options?: DocumentModificationOptions,
       userId?: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
   }
 
   namespace MeasuredTemplate {