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

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

@@ -1,5 +1,9 @@
-import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredDocumentClassForName,
+  ConfiguredObjectClassForName
+} from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -54,8 +58,7 @@ declare global {
     /** @defaultValue `undefined` */
     icon?: PIXI.Sprite;
 
-    /** @override */
-    static embeddedName: 'Token';
+    static override embeddedName: 'Token';
 
     /**
      * Establish an initial velocity of the token based on it's direction of facing.
@@ -92,8 +95,7 @@ declare global {
      */
     readonly name: string;
 
-    /** @override */
-    get bounds(): Rectangle;
+    override get bounds(): Rectangle;
 
     /**
      * Translate the token's grid width into a pixel width based on the canvas size
@@ -207,11 +209,9 @@ declare global {
      */
     protected _isVisionSource(): boolean;
 
-    /** @override */
-    clear(): this;
+    override clear(): this;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
     /**
      * Draw the HUD container which provides an interface for managing this Token
@@ -219,8 +219,7 @@ declare global {
      */
     protected _drawHUD(): Token.InitializedObjectHUD;
 
-    /** @override */
-    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
 
     /**
      * Apply initial sanitizations to the provided input data to ensure that a Token has valid required attributes.
@@ -258,6 +257,12 @@ declare global {
      */
     refresh(): this;
 
+    /**
+     * Size and display the Token Icon
+     * @internal
+     */
+    protected _refreshIcon(): void;
+
     /**
      * Draw the Token border, taking into consideration the grid type and border color
      * @internal
@@ -399,12 +404,10 @@ declare global {
     /**
      * @param releaseOthers - (default: `true`)
      * @param pan           - (default: `false`)
-     * @override
      */
-    protected _onControl({ releaseOthers, pan }?: { releaseOthers?: boolean; pan?: boolean }): void;
+    protected override _onControl({ releaseOthers, pan }?: { releaseOthers?: boolean; pan?: boolean }): void;
 
-    /** @override */
-    protected _onRelease(
+    protected override _onRelease(
       options: PlaceableObject.ReleaseOptions
     ): Promise<InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>> | undefined;
 
@@ -444,27 +447,12 @@ declare global {
 
     /**
      * Set this Token as an active target for the current game User
-     * @param targeted       - Is the Token now targeted?
-     *                         (default: `true`)
-     * @param user           - Assign the token as a target for a specific User
-     *                         (default: `null` which will use the current user)
-     * @param releaseOthers  - Release other active targets for the same player?
-     *                         (default: `true`)
-     * @param groupSelection - Is this target being set as part of a group selection workflow?
-     *                         (default: `false`)
-     */
-    setTarget(
-      targeted?: boolean,
-      {
-        user,
-        releaseOthers,
-        groupSelection
-      }?: {
-        user?: InstanceType<ConfiguredDocumentClass<typeof User>> | null;
-        releaseOthers?: boolean;
-        groupSelection?: boolean;
-      }
-    ): void;
+     * @param targeted - Is the Token now targeted?
+     *                   (default: `true`)
+     * @param context  - Additional context options
+     *                   (default `{}`)
+     */
+    setTarget(targeted?: boolean, context?: Token.SetTargetContext | undefined): void;
 
     /**
      * Add or remove the currently controlled Tokens from the active combat encounter
@@ -516,82 +504,68 @@ declare global {
      */
     getLightRadius(units: number): number;
 
-    /** @override */
-    protected _getShiftedPosition(dx: number, dy: number): { x: number; y: number };
+    protected override _getShiftedPosition(dx: number, dy: number): { x: number; y: number };
 
-    /**
-     * Extend the PlaceableObject.rotate method to prevent rotation if the Token is in the midst of a movement animation
-     * @returns Actually a Promise<void>
-     * @remarks The return type is `Promise<this> | undefined` but this breaks the interface of PlaceableObject, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6876
-     */
-    rotate(...args: Parameters<PlaceableObject['rotate']>): any;
+    override rotate(...args: Parameters<PlaceableObject['rotate']>): Promise<this>;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       options: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>['data']['_source'],
       userId: DocumentModificationOptions
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data?: DeepPartial<InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>['data']['_source']>,
       options?: DocumentModificationOptions & { animate?: boolean },
       userId?: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options?: DocumentModificationOptions, userId?: string): void;
+    protected override _onDelete(options?: DocumentModificationOptions, userId?: string): void;
 
-    /** @override */
-    protected _canControl(
+    protected override _canControl(
       user?: InstanceType<ConfiguredDocumentClass<typeof User>>,
       event?: PIXI.InteractionEvent
     ): boolean;
 
-    /** @override */
-    protected _canHUD(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: PIXI.InteractionEvent): boolean;
+    protected override _canHUD(
+      user: InstanceType<ConfiguredDocumentClass<typeof User>>,
+      event?: PIXI.InteractionEvent
+    ): boolean;
 
-    /** @override */
-    protected _canConfigure(
+    protected override _canConfigure(
       user?: InstanceType<ConfiguredDocumentClass<typeof User>>,
       event?: PIXI.InteractionEvent
     ): true;
 
-    /** @override */
-    protected _canHover(user?: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: PIXI.InteractionEvent): true;
+    protected override _canHover(
+      user?: InstanceType<ConfiguredDocumentClass<typeof User>>,
+      event?: PIXI.InteractionEvent
+    ): true;
 
-    /** @override */
-    protected _canView(
+    protected override _canView(
       user?: InstanceType<ConfiguredDocumentClass<typeof User>>,
       event?: PIXI.InteractionEvent
     ): boolean;
 
-    /** @override */
-    protected _canDrag(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event: PIXI.InteractionEvent): boolean;
+    protected override _canDrag(
+      user: InstanceType<ConfiguredDocumentClass<typeof User>>,
+      event: PIXI.InteractionEvent
+    ): boolean;
 
-    /** @override */
-    protected _onHoverIn(event: PIXI.InteractionEvent, options?: { hoverOutOthers?: boolean }): void;
+    protected override _onHoverIn(event: PIXI.InteractionEvent, options?: { hoverOutOthers?: boolean }): void;
 
-    /** @override */
-    protected _onHoverOut(event: PIXI.InteractionEvent): false | void;
+    protected override _onHoverOut(event: PIXI.InteractionEvent): false | void;
 
-    /** @override */
-    protected _onClickLeft(event: PIXI.InteractionEvent): void;
+    protected override _onClickLeft(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onClickLeft2(event?: PIXI.InteractionEvent): void;
+    protected override _onClickLeft2(event?: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onClickRight2(event: PIXI.InteractionEvent): void;
+    protected override _onClickRight2(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<any>;
+    protected override _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<any>;
 
-    /** @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;
     /**
      * @remarks This does not exist in foundry. It marks the controlIcon as not used because `Token` does never store a value here.
      */
@@ -718,5 +692,31 @@ declare global {
        */
       overlay?: boolean | undefined;
     }
+
+    interface SetTargetContext {
+      /**
+       * Assign the token as a target for a specific User
+       * @defaultValue `null`
+       */
+      user?: InstanceType<ConfiguredDocumentClass<typeof User>> | null | undefined;
+
+      /**
+       * Release other active targets for the same player?
+       * @defaultValue `true`
+       */
+      releaseOthers?: boolean | undefined;
+
+      /**
+       * Is this target being set as part of a group selection workflow?
+       * @defaultValue `Is this target being set as part of a group selection workflow?`
+       */
+      groupSelection?: boolean | undefined;
+    }
   }
+
+  /**
+   * A "secret" global to help debug attributes of the currently controlled Token.
+   * This is only for debugging, and may be removed in the future, so it's not safe to use.
+   */
+  let _token: InstanceType<ConfiguredObjectClassForName<'Token'>> | null;
 }

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

@@ -2,10 +2,10 @@ import type {
   ConfiguredDocumentClass,
   ConfiguredDocumentClassForName,
   ConfiguredObjectClassForName
-} from '../../../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
-import type { LineIntersection } from '../../../../common/utils/geometry.mjs';
-import type { HoverInOptions } from '../placeableObject';
+} from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { LineIntersection } from '../../../common/utils/geometry.mjs';
+import type { HoverInOptions } from '../placeable';
 
 declare global {
   /**
@@ -55,8 +55,7 @@ declare global {
      */
     protected _wallKeys: Set<string> | null;
 
-    /** @override */
-    static embeddedName: 'Wall';
+    static override embeddedName: 'Wall';
 
     /**
      * A convenience reference to the coordinates Array for the Wall endpoints, [x0,y0,x1,y1].
@@ -83,8 +82,7 @@ declare global {
      */
     get wallKeys(): Set<string>;
 
-    /** @override */
-    get bounds(): NormalizedRectangle;
+    override get bounds(): NormalizedRectangle;
 
     /**
      * A boolean for whether this wall contains a door
@@ -106,8 +104,7 @@ declare global {
      */
     get midpoint(): PointArray;
 
-    /** @override */
-    get center(): PIXI.Point;
+    override get center(): PIXI.Point;
 
     /**
      * Get the direction of effect for a directional Wall
@@ -121,8 +118,7 @@ declare global {
      */
     toRay(): Ray;
 
-    /** @override */
-    draw(): Promise<this>;
+    override draw(): Promise<this>;
 
     /**
      * Draw a control icon that is used to manipulate the door's open/closed state
@@ -137,11 +133,9 @@ declare global {
      */
     orientPoint(point: Point): number;
 
-    /** @override */
-    protected _createInteractionManager(): NonNullable<this['mouseInteractionManager']>;
+    protected override _createInteractionManager(): NonNullable<this['mouseInteractionManager']>;
 
-    /** @override */
-    activateListeners(): void;
+    override activateListeners(): void;
 
     /**
      * Draw a directional prompt icon for one-way walls to illustrate their direction of effect.
@@ -150,8 +144,7 @@ declare global {
      */
     protected _drawDirection(): PIXI.Sprite | null;
 
-    /** @override */
-    refresh(): this;
+    override refresh(): this;
 
     /**
      * Compute an approximate Polygon which encloses the line segment providing a specific hitArea for the line
@@ -169,16 +162,13 @@ declare global {
     protected _getWallColor(): number;
 
     /**
-     * @override
      * @param chain - (default: `false`)
      */
-    protected _onControl({ chain }?: PlaceableObject.ControlOptions & { chain?: boolean }): void;
+    protected override _onControl({ chain }?: PlaceableObject.ControlOptions & { chain?: boolean }): void;
 
-    /** @override */
-    protected _onRelease(options?: PlaceableObject.ReleaseOptions): void;
+    protected override _onRelease(options?: PlaceableObject.ReleaseOptions): void;
 
-    /** @override */
-    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+    override destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
 
     /**
      * Test whether the Wall direction lies between two provided angles
@@ -227,22 +217,19 @@ declare global {
      */
     protected _removeIntersections(): void;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.WallData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.WallData['_source']>,
       options?: DocumentModificationOptions,
       userId?: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Callback actions when a wall that contains a door is moved or its state is changed
@@ -252,14 +239,11 @@ declare global {
      */
     protected _onModifyWall(doorChange?: boolean): Promise<void>;
 
-    /** @override */
-    protected _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
+    protected override _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): 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;
 
     /**
      * Handle mouse-hover events on the line segment itself, pulling the Wall to the front of the container stack
@@ -267,23 +251,17 @@ declare global {
      */
     protected _onMouseOverLine(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onClickLeft(event: PIXI.InteractionEvent): boolean;
+    protected override _onClickLeft(event: PIXI.InteractionEvent): boolean;
 
-    /** @override */
-    protected _onClickLeft2(event: PIXI.InteractionEvent): void;
+    protected override _onClickLeft2(event: PIXI.InteractionEvent): void;
 
-    /** @override */
-    protected _onClickRight2(event: PIXI.InteractionEvent): void;
+    protected override _onClickRight2(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<any>;
+    protected override _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<any>;
   }
 }
 

package/src/foundry/{foundry.js/pixi/containers/canvasLayers/placeablesLayer.d.ts → client/pixi/placeables.d.ts}

@@ -1,11 +1,11 @@
 import {
   DataSourceForPlaceable,
-  ConfiguredDocumentClass,
   ConfiguredObjectClassForName,
   ConfiguredDocumentClassForName,
-  PlaceableDocumentType
-} from '../../../../../types/helperTypes';
-import EmbeddedCollection from '../../../../common/abstract/embedded-collection.mjs';
+  PlaceableDocumentType,
+  ConstructorDataType
+} from '../../../types/helperTypes';
+import EmbeddedCollection from '../../common/abstract/embedded-collection.mjs';
 
 type ConcretePlaceableOrPlaceableObject<T> = T extends PlaceableObject ? T : PlaceableObject;
 
@@ -69,8 +69,7 @@ declare global {
       ConcretePlaceableOrPlaceableObject<InstanceType<ConfiguredObjectClassForName<DocumentName>>>
     > | null;
 
-    /** @override */
-    static get layerOptions(): PlaceablesLayer.LayerOptions<any>;
+    static override get layerOptions(): PlaceablesLayer.LayerOptions<any>;
 
     /**
      * A reference to the named Document type which is contained within this Canvas Layer.
@@ -78,6 +77,16 @@ declare global {
      */
     static documentName: PlaceableDocumentType;
 
+    /**
+     * Creation states affected to placeables during their construction.
+     */
+    static CREATION_STATES: Readonly<{
+      NONE: 0;
+      POTENTIAL: 1;
+      CONFIRMED: 2;
+      COMPLETED: 3;
+    }>;
+
     /**
      * Obtain a reference to the Collection of embedded Document instances within the currently viewed Scene
      */
@@ -120,26 +129,27 @@ declare global {
       | InstanceType<ConfiguredDocumentClassForName<DocumentName>>[];
 
     /**
-     * @override
      * @remarks It returns Promise<this> but is overridden by a subclass in this way.
      */
-    draw(): Promise<this | undefined>;
+    override draw(): Promise<this | undefined>;
 
     /**
      * Draw a single placeable object
      */
     createObject(
       data: InstanceType<ConfiguredDocumentClassForName<DocumentName>>
-    ): InstanceType<ConfiguredObjectClassForName<DocumentName>>;
+    ): InstanceType<ConfiguredObjectClassForName<DocumentName>> | null;
+
+    override tearDown(): Promise<this>;
 
-    /** @override */
-    tearDown(): Promise<this>;
+    override activate(): this;
 
-    /** @override */
-    activate(): this;
+    override deactivate(): this;
 
-    /** @override */
-    deactivate(): this;
+    /**
+     * Clear the contents of the preview container, restoring visibility of original (non-preview) objects.
+     */
+    clearPreviewContainer(): void;
 
     /**
      * Get a PlaceableObject contained in this layer by it's ID
@@ -246,7 +256,7 @@ declare global {
      * @param transformation - An object of data or function to apply to all matched objects
      * @param condition      - A function which tests whether to target each object
      *                         (default: `null`)
-     * @param options        - Additional options passed to Entity.update
+     * @param options        - Additional options passed to Document.update
      *                         (default: `{}`)
      * @returns An array of updated data once the operation is complete
      */
@@ -268,16 +278,43 @@ declare global {
       options?: DocumentModificationContext
     ): Promise<Array<InstanceType<ConfiguredDocumentClassForName<DocumentName>>>>;
 
+    /**
+     * Get the world-transformed drop position.
+     * @returns Returns the transformed x, y co-ordinates, or false if the drag event was outside the canvas.
+     */
+    protected _canvasCoordinatesFromDrop(
+      event: DragEvent,
+      {
+        center
+      }?:
+        | {
+            /**
+             * Return the co-ordinates of the center of the nearest grid element.
+             * @defaultValue `true`
+             */
+            center?: boolean | undefined;
+          }
+        | undefined
+    ): [tx: number, ty: number] | false;
+
+    /**
+     * Create a preview of this layer's object type from a world document and show its sheet so it can be finalized.
+     * @param createData - The data to create the object with.
+     * @param position   - The position to render the sheet at.
+     */
+    protected _createPreview(
+      createData: ConstructorDataType<InstanceType<ConfiguredDocumentClassForName<DocumentName>>['data']>,
+      { top, left }: { top: number; left: number }
+    ): Promise<void>;
+
     /**
      * Handle left mouse-click events which originate from the Canvas stage and are dispatched to this Layer.
-     * @param event - (unused)
      * @see {@link Canvas#_onClickLeft}
      */
     protected _onClickLeft(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle double left-click events which originate from the Canvas stage and are dispatched to this Layer.
-     * @param event - (unused)
      * @see {@link Canvas#_onClickLeft2}
      */
     protected _onClickLeft2(event: PIXI.InteractionEvent): void;
@@ -302,14 +339,12 @@ declare global {
 
     /**
      * Cancel a left-click drag workflow originating from the Canvas stage.
-     * @param event - (unused)
      * @see {@link Canvas#_onDragLeftDrop}
      */
     protected _onDragLeftCancel(event: PointerEvent): void;
 
     /**
      * Handle right mouse-click events which originate from the Canvas stage and are dispatched to this Layer.
-     * @param event - (unused)
      * @see {@link Canvas#_onClickRight}
      */
     protected _onClickRight(event: PIXI.InteractionEvent): void;
@@ -324,38 +359,8 @@ declare global {
     /**
      * Handle a DELETE keypress while a placeable object is hovered
      * @param event - The delete key press event which triggered the request
-     *                (unused)
      */
     protected _onDeleteKey(event?: any): void;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    static get dataArray(): string;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    createMany(
-      data: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1],
-      options: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[2]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    updateMany(
-      data: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['updateEmbeddedDocuments']>[1],
-      options: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['updateEmbeddedDocuments']>[2]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['updateEmbeddedDocuments']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    deleteMany(
-      data: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['deleteEmbeddedDocuments']>[1],
-      options: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['deleteEmbeddedDocuments']>[2]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['deleteEmbeddedDocuments']>;
   }
 
   interface CanvasHistory<Placeable extends PlaceableObject> {
@@ -373,6 +378,8 @@ declare global {
   namespace PlaceablesLayer {
     type HistoryEventType = 'create' | 'update' | 'delete';
 
+    type CreationState = ValueOf<typeof PlaceablesLayer['CREATION_STATES']>;
+
     /**
      * @typeParam DocumentName - The key of the configuration which defines the object and document class.
      */
@@ -409,15 +416,9 @@ declare global {
 
       /**
        * Does this layer use a quadtree to track object positions?
-       * @defaultValue `false`
+       * @defaultValue `true`
        */
       quadtree: boolean;
-
-      /**
-       * The FormApplication class used to configure objects on this layer.
-       * @defaultValue `CONFIG[this.documentName].sheetClass`
-       */
-      sheetClass: ConstructorOf<FormApplication>;
     }
   }
 }

package/src/foundry/client/pixi/sources/index.d.ts

@@ -0,0 +1,4 @@
+import './base-source';
+import './light-source';
+import './sound-source';
+import './vision-source';