@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

package/src/foundry/client/pixi/placeable.d.ts

@@ -1,414 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import { Document } from '../../common/abstract/module.mjs';
-
-declare global {
-  /**
-   * 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<
-      any,
-      InstanceType<ConfiguredDocumentClass<typeof Scene>>
-    >
-  > extends PIXI.Container {
-    /**
-     * @param document - The Document instance which is represented by this object
-     */
-    constructor(document: D);
-
-    /** @internal */
-    protected _original?: this | undefined;
-
-    /**
-     * Retain a reference to the Scene within which this Placeable Object resides
-     */
-    scene: InstanceType<ConfiguredDocumentClass<typeof Scene>>;
-
-    /**
-     * A reference to the Scene embedded Document instance which this object represents
-     */
-    document: D;
-
-    /**
-     * The underlying data object which provides the basis for this placeable object
-     */
-    data: D['data'];
-
-    /**
-     * Track the field of vision for the placeable object.
-     * This is necessary to determine whether a player has line-of-sight towards a placeable object or vice-versa
-     * @defaultValue `{ fov: undefined, los: undefined }`
-     */
-    vision: Vision;
-
-    /**
-     * A control icon for interacting with the object
-     * @defaultValue `null`
-     * @remarks `undefined` is returned by subclasses only
-     */
-    controlIcon: ControlIcon | null | undefined;
-
-    /**
-     * A mouse interaction manager instance which handles mouse workflows related to this object.
-     * @defaultValue `null`
-     */
-    mouseInteractionManager: MouseInteractionManager<this> | null;
-
-    /**
-     * An indicator for whether the object is currently controlled
-     * @defaultValue `false`
-     */
-    protected _controlled: boolean;
-
-    /**
-     * An indicator for whether the object is currently a hover target
-     * @defaultValue `false`
-     */
-    protected _hover: boolean;
-
-    /**
-     * Identify the official Document name for this PlaceableObject class
-     * @remarks This is abstract in {@link PlaceableObject}.
-     */
-    static embeddedName: string;
-
-    /**
-     * The bounding box for this PlaceableObject.
-     * This is required if the layer uses a Quadtree, otherwise it is optional
-     */
-    abstract get bounds(): Rectangle;
-
-    /**
-     * The central coordinate pair of the placeable object based on it's own width and height
-     * @remarks `{ x: number, y: number }` has been added because of `Token.center`
-     */
-    get center(): PIXI.Point | { x: number; y: number };
-
-    /**
-     * The id of the corresponding Document which this PlaceableObject represents.
-     */
-    get id(): string;
-
-    /**
-     * The field-of-vision polygon for the object, if it has been computed
-     */
-    get fov(): this['vision']['fov'];
-
-    /**
-     * Provide a reference to the CanvasLayer which contains this PlaceableObject.
-     */
-    get layer(): 'layer' extends keyof D ? D['layer'] : PIXI.Container;
-
-    /**
-     * The line-of-sight polygon for the object, if it has been computed
-     */
-    get los(): this['vision']['los'];
-
-    /**
-     * 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;
-
-    /**
-     * Test whether a user can perform a certain interaction with regards to a Placeable Object
-     * @param user   - The User performing the action
-     * @param action - The named action being attempted
-     * @returns Does the User have rights to perform the action?
-     */
-    can(
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>,
-      action: 'HUD' | 'configure' | 'control' | 'view' | 'create' | 'drag' | 'hover' | 'update' | 'delete' | string
-    ): boolean;
-
-    /**
-     * Can the User access the HUD for this Placeable Object?
-     */
-    protected _canHUD(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to configure the Placeable Object?
-     */
-    protected _canConfigure(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to control the Placeable Object?
-     */
-    protected _canControl(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to view details of the Placeable Object?
-     */
-    protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to create the underlying Document?
-     */
-    protected _canCreate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to drag this Placeable Object?
-     */
-    protected _canDrag(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to hover on this Placeable Object?
-     */
-    protected _canHover(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to update the underlying Document?
-     */
-    protected _canUpdate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Does the User have permission to delete the underlying Document?
-     */
-    protected _canDelete(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
-
-    /**
-     * Clear the display of the existing object
-     * @returns The cleared object
-     */
-    clear(): this;
-
-    /**
-     * Clone the placeable object, returning a new object with identical attributes
-     * The returned object is non-interactive, and has no assigned ID
-     * If you plan to use it permanently you should call the create method
-     *
-     * @returns A new object with identical data
-     */
-    clone(): this;
-
-    override destroy(options?: Parameters<PIXI.Container['destroy']>[0]): void;
-
-    /**
-     * Draw the placeable object into its parent container
-     * @returns The drawn object
-     */
-    abstract draw(): Promise<this>;
-
-    /**
-     * Refresh the current display state of the Placeable Object
-     * @returns The refreshed object
-     * @remarks `void` has been added because of `Drawing.refresh`
-     */
-    abstract refresh(): this | void;
-
-    /**
-     * Register pending canvas operations which should occur after a new PlaceableObject of this type is created
-     */
-    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
-     * @remarks Called without options and userId in Drowing._onUpdate
-     */
-    protected _onUpdate(
-      changed: DeepPartial<D['data']['_source']>,
-      options?: DocumentModificationOptions,
-      userId?: string
-    ): void;
-
-    /**
-     * Define additional steps taken when an existing placeable object of this type is deleted
-     */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    /**
-     * Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors
-     * @param options - Additional options which modify the control request
-     *                  (default: `{}`)
-     * @returns A flag denoting whether or not control was successful
-     */
-    control(options?: PlaceableObject.ControlOptions): boolean;
-
-    /**
-     * Additional events which trigger once control of the object is established
-     * @param options - Optional parameters which apply for specific implementations
-     */
-    protected _onControl(options?: PlaceableObject.ControlOptions): void;
-
-    /**
-     * Release control over a PlaceableObject, removing it from the controlled set
-     * @param options - Options which modify the releasing workflow
-     *                  (default: `{}`)
-     * @returns A Boolean flag confirming the object was released.
-     */
-    release(options?: PlaceableObject.ReleaseOptions): boolean;
-
-    /**
-     * Additional events which trigger once control of the object is released
-     * @param options - Options which modify the releasing workflow
-     */
-    protected _onRelease(options?: PlaceableObject.ReleaseOptions): void;
-
-    /**
-     * Rotate the PlaceableObject to a certain angle of facing
-     * @param angle - The desired angle of rotation
-     * @param snap  - Snap the angle of rotation to a certain target degree increment
-     * @returns A Promise which resolves once the rotation has completed
-     */
-    rotate(angle: number, snap: number): Promise<this>;
-
-    /**
-     * Determine a new angle of rotation for a PlaceableObject either from an explicit angle or from a delta offset.
-     * @param options - An object which defines the rotation update parameters
-     * @param angle - An explicit angle, either this or delta must be provided
-     *                (default: `null`)
-     * @param delta - A relative angle delta, either this or the angle must be provided
-     *                (default: `0`)
-     * @param snap  - A precision (in degrees) to which the resulting angle should snap.
-     *                (default: `0`)
-     * @returns The new rotation angle for the object
-     */
-    protected _updateRotation({ angle, delta, snap }?: RotationOptions): number;
-
-    /**
-     * Obtain a shifted position for the Placeable Object
-     * @param dx - The number of grid units to shift along the X-axis
-     * @param dy - The number of grid units to shift along the Y-axis
-     * @returns The shifted target coordinates
-     */
-    protected _getShiftedPosition(dx: number, dy: number): { x: number; y: number };
-
-    /**
-     * Activate interactivity for the Placeable Object
-     */
-    activateListeners(): void;
-
-    /**
-     * Create a standard MouseInteractionManager for the PlaceableObject
-     */
-    protected _createInteractionManager(): NonNullable<this['mouseInteractionManager']>;
-
-    /**
-     * Actions that should be taken for this Placeable Object when a mouseover event occurs
-     * @see MouseInteractionManager#_handleMouseOver
-     * @param event   - The triggering canvas interaction event
-     * @param options - Options which customize event handling
-     *                  (default: `{}`)
-     */
-    protected _onHoverIn(event: PIXI.InteractionEvent, options?: HoverInOptions): false | void;
-
-    /**
-     * Actions that should be taken for this Placeable Object when a mouseout event occurs
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onHoverOut(event: PIXI.InteractionEvent): false | void;
-
-    /**
-     * Callback actions which occur on a single left-click event to assume control of the object
-     * @see MouseInteractionManager#_handleClickLeft
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onClickLeft(event: PIXI.InteractionEvent): boolean | void;
-
-    /**
-     * Callback actions which occur on a double left-click event to activate
-     * @see MouseInteractionManager#_handleClickLeft2
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onClickLeft2(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Callback actions which occur on a single right-click event to configure properties of the object
-     * @see MouseInteractionManager#_handleClickRight
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onClickRight(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Callback actions which occur on a double right-click event to configure properties of the object
-     * @see MouseInteractionManager#_handleClickRight2
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onClickRight2(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Callback actions which occur when a mouse-drag action is first begun.
-     * @see MouseInteractionManager#_handleDragStart
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onDragLeftStart(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Callback actions which occur on a mouse-move operation.
-     * @see MouseInteractionManager#_handleDragMove
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Callback actions which occur on a mouse-move operation.
-     * @see MouseInteractionManager#_handleDragDrop
-     * @param event - The triggering canvas interaction event
-     */
-    protected _onDragLeftDrop(event: PIXI.InteractionEvent): unknown;
-
-    /**
-     * Callback actions which occur on a mouse-move operation.
-     * @see MouseInteractionManager#_handleDragCancel
-     * @param event - The triggering mouse click event
-     */
-    protected _onDragLeftCancel(event: MouseEvent): void;
-  }
-
-  namespace PlaceableObject {
-    interface ControlOptions {
-      /**
-       * Release any other controlled objects first
-       */
-      releaseOthers?: boolean;
-    }
-
-    interface ReleaseOptions {
-      trigger?: boolean;
-    }
-  }
-}
-
-interface Vision {
-  /**
-   * @remarks
-   * This is required but has been set to optional because of PointSource
-   */
-  fov?: PIXI.Circle | undefined;
-
-  /**
-   * @remarks
-   * This is required but has been set to optional because of PointSource
-   */
-  los?: PointSourcePolygon | undefined;
-}
-
-interface RotationOptions {
-  /**
-   * An explicit angle, either this or delta must be provided
-   * @defaultValue `undefined`
-   */
-  angle?: number;
-
-  /**
-   * A relative angle delta, either this or the angle must be provided
-   * @defaultValue `0`
-   */
-  delta?: number;
-
-  /**
-   * A precision (in degrees) to which the resulting angle should snap. Default is 0.
-   * @defaultValue `0`
-   */
-  snap?: number;
-}
-
-interface HoverInOptions {
-  /**
-   * Trigger hover-out behavior on sibling objects
-   *
-   * @defaultValue `true`
-   */
-  hoverOutOthers: boolean;
-}

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

@@ -1,289 +0,0 @@
-import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * The Drawing object is an implementation of the PlaceableObject container.
-   * Each Drawing is a placeable object in the DrawingsLayer.
-   */
-  class Drawing extends PlaceableObject<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>> {
-    constructor(document: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>);
-    /**
-     * @remarks Not used for `Drawing`
-     */
-    controlIcon: null;
-
-    /**
-     * The inner drawing container
-     * @defaultValue `null`
-     */
-    drawing: PIXI.Container | null;
-
-    /**
-     * The primary drawing shape
-     * @defaultValue `null`
-     */
-    shape: PIXI.Graphics | null;
-
-    /**
-     * Text content, if included
-     * @defaultValue `null`
-     */
-    text: PIXI.Text | null;
-
-    /**
-     * The Graphics outer frame and handles
-     * @defaultValue `null`
-     */
-    frame: PIXI.Container | null;
-
-    /**
-     * 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]>;
-
-    static override embeddedName: 'Drawing';
-
-    /**
-     * The rate at which points are sampled (in milliseconds) during a freehand drawing workflow
-     * @defaultValue `75`
-     */
-    static FREEHAND_SAMPLE_RATE: number;
-
-    override get bounds(): Rectangle;
-
-    /**
-     * A Boolean flag for whether or not the Drawing utilizes a tiled texture background
-     */
-    get isTiled(): boolean;
-
-    /**
-     * A Boolean flag for whether or not the Drawing is a Polygon type (either linear or freehand)
-     */
-    get isPolygon(): boolean;
-
-    override draw(): Promise<this>;
-
-    /**
-     * Clean the drawing data to constrain its allowed position
-     * @internal
-     */
-    protected _cleanData(): void;
-
-    /**
-     * Create the components of the drawing element, the drawing container, the drawn shape, and the overlay text
-     */
-    protected _createDrawing(): void;
-
-    /**
-     * Create elements for the foreground text
-     * @internal
-     */
-    protected _createText(): PreciseText;
-
-    /**
-     * Create elements for the Drawing border and handles
-     * @internal
-     */
-    protected _createFrame(): void;
-
-    override refresh(): void;
-
-    /**
-     * 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;
-
-    /**
-     * Attribution: The equations for how to calculate the bezier control points are derived from Rob Spencer's article:
-     * http://scaledinnovation.com/analytics/splines/aboutSplines.html
-     * @param factor   - The smoothing factor
-     * @param previous - The prior point
-     * @param point    - The current point
-     * @param next     - The next point
-     * @internal
-     */
-    protected _getBezierControlPoints(
-      factor: number,
-      previous: [number, number],
-      point: [number, number],
-      next: [number, number]
-    ): {
-      cp1: {
-        x: number;
-        y: number;
-      };
-      next_cp0: {
-        x: number;
-        y: number;
-      };
-    };
-
-    /**
-     * 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;
-
-    protected override _onControl(options: PlaceableObject.ControlOptions & { isNew?: boolean }): void;
-
-    protected override _onRelease(options: PlaceableObject.ReleaseOptions): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    /**
-     * Handle text entry in an active text tool
-     * @internal
-     */
-    protected _onDrawingTextKeydown(event: KeyboardEvent): void;
-
-    protected override _onUpdate(data: DeepPartial<foundry.data.DrawingData['_source']>): void;
-
-    /**
-     * @param event - unused
-     */
-    protected override _canControl(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
-
-    /**
-     * @param user  - unused
-     * @param event - unused
-     */
-    protected override _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;
-
-    protected override _onDragLeftStart(event: PIXI.InteractionEvent): void;
-
-    protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-    protected override _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<unknown>;
-
-    protected override _onDragLeftCancel(event: MouseEvent): void;
-
-    /**
-     * 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
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>['update']>;
-
-    /**
-     * Handle cancellation of a drag event for one of the resizing handles
-     * @internal
-     */
-    protected _onHandleDragCancel(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Apply a vectorized rescaling transformation for the drawing data
-     * @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'>,
-      dx: number,
-      dy: number
-    ): Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'width' | 'height' | 'points'>;
-
-    /**
-     * Adjust the location, dimensions, and points of the Drawing before committing the change
-     * @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'>;
-  }
-}

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

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