@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts

@@ -1,358 +0,0 @@
-import type { Brand, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * Handle mouse interaction events for a Canvas object.
-   * There are three phases of events: hover, click, and drag
-   *
-   * Hover Events:
-   * _handlePointerOver
-   *  action: hoverIn
-   * _handlePointerOut
-   *  action: hoverOut
-   *
-   * Left Click and Double-Click
-   * _handlePointerDown
-   *  action: clickLeft
-   *  action: clickLeft2
-   *  action: unclickLeft
-   *
-   * Right Click and Double-Click
-   * _handleRightDown
-   *  action: clickRight
-   *  action: clickRight2
-   *  action: unclickRight
-   *
-   * Drag and Drop
-   * _handlePointerMove
-   *  action: dragLeftStart
-   *  action: dragRightStart
-   *  action: dragLeftMove
-   *  action: dragRightMove
-   * _handlePointerUp
-   *  action: dragLeftDrop
-   *  action: dragRightDrop
-   * _handleDragCancel
-   *  action: dragLeftCancel
-   *  action: dragRightCancel
-   */
-  class MouseInteractionManager<ObjectFor extends PIXI.Container = PIXI.Container> {
-    /**
-     * @param permissions - (default: `{}`)
-     * @param callbacks   - (default: `{}`)
-     * @param options     - (default: `{}`)
-     * @remarks Foundry does not provide type information for the constructor, everything here is inferred from usage
-     */
-    constructor(
-      object: ObjectFor,
-      layer: PIXI.Container,
-      permissions?: MouseInteractionManager.Permissions,
-      callbacks?: MouseInteractionManager.Callbacks,
-      options?: MouseInteractionManager.Options,
-    );
-
-    object: ObjectFor;
-
-    layer: PIXI.Container;
-
-    /**
-     * @defaultValue `{}`
-     */
-    permissions: MouseInteractionManager.Permissions;
-
-    /**
-     * @defaultValue `{}`
-     */
-    callbacks: MouseInteractionManager.Callbacks;
-
-    /**
-     * @defaultValue `{}`
-     */
-    options: MouseInteractionManager.Options;
-
-    /**
-     * The current interaction state
-     * @defaultValue `MouseInteractionManager.INTERACTION_STATES.NONE`
-     */
-    state: MouseInteractionManager.INTERACTION_STATES;
-
-    /**
-     * Bound handlers which can be added and removed
-     * @defaultValue `{}`
-     */
-    interactionData: MouseInteractionManager.InteractionData<ObjectFor>;
-
-    /**
-     * The drag handling time
-     * @defaultValue `0`
-     */
-    dragTime: number;
-
-    /**
-     * The time of the last left-click event
-     * @defaultValue `0`
-     */
-    lcTime: number;
-
-    /**
-     * The time of the last right-click event
-     * @defaultValue `0`
-     */
-    rcTime: number;
-
-    /**
-     * A flag for whether we are right-click dragging
-     * @defaultValue `false`
-     */
-    _dragRight: boolean;
-
-    /**
-     * An optional ControlIcon instance for the object
-     */
-    controlIcon: ControlIcon | null;
-
-    /**
-     * The view id pertaining to the PIXI Application.
-     * If not provided, default to canvas.app.view.id
-     */
-    viewId: string;
-
-    /**
-     * The client position of the last left/right-click.
-     */
-    lastClick: PIXI.Point;
-
-    /**
-     * Enumerate the states of a mouse interaction workflow.
-     * 0: NONE - the object is inactive
-     * 1: HOVER - the mouse is hovered over the object
-     * 2: CLICKED - the object is clicked
-     * 3: GRABBED - the object is grabbed
-     * 4: DRAG - the object is being dragged
-     * 5: DROP - the object is being dropped
-     */
-    static INTERACTION_STATES: MouseInteractionManager.InteractionStates;
-
-    /**
-     * The maximum number of milliseconds between two clicks to be considered a double-click.
-     * @defaultValue `250`
-     */
-    static DOUBLE_CLICK_TIME_MS: number;
-
-    /**
-     * The maximum number of pixels between two clicks to be considered a double-click.
-     * @defaultValue `5`
-     */
-    static DOUBLE_CLICK_DISTANCE_PX: number;
-
-    /**
-     * The number of milliseconds of mouse click depression to consider it a long press.
-     * @defaultValue `500`
-     */
-    static LONG_PRESS_DURATION_MS: number;
-
-    /**
-     * Global timeout for the long-press event.
-     * @defaultValue `null`
-     */
-    static longPressTimeout: number | null;
-
-    /**
-     * Emulate a pointermove event. Needs to be called when an object with the static event mode
-     * or any of its parents is transformed or its visibility is changed.
-     */
-    static emulateMoveEvent(): void;
-
-    /**
-     * Get the target.
-     */
-    get target(): PIXI.DisplayObject;
-
-    /**
-     * Is this mouse manager in a dragging state?
-     */
-    get isDragging(): boolean;
-
-    /**
-     * Activate interactivity for the handled object
-     */
-    activate(): this;
-
-    /**
-     * Test whether the current user has permission to perform a step of the workflow
-     * @param action - The action being attempted
-     * @param event  - The event being handled
-     * @returns Can the action be performed?
-     */
-    can(action: MouseInteractionManager.PermissionAction, event: Event | PIXI.FederatedEvent): boolean;
-
-    /**
-     * Execute a callback function associated with a certain action in the workflow
-     * @param action - The action being attempted
-     * @param event  - The event being handled
-     * @param args   - Additional callback arguments.
-     * @returns A boolean which may indicate that the event was handled by the callback.
-     *          Events which do not specify a callback are assumed to have been handled as no-op.
-     * @remarks
-     */
-    callback(action: MouseInteractionManager.Action, event: Event | PIXI.FederatedEvent, ...args: any[]): boolean;
-
-    /**
-     * A reference to the possible interaction states which can be observed
-     */
-    get states(): typeof MouseInteractionManager.INTERACTION_STATES;
-
-    /**
-     * A reference to the possible interaction states which can be observed
-     */
-    get handlerOutcomes(): MouseInteractionManager.HandlerOutcomes;
-    /**
-     * A public method to handle directly an event into this manager, according to its type.
-     * Note: drag events are not handled.
-     * @returns Has the event been processed?
-     */
-    handleEvent(event: PIXI.FederatedEvent): boolean;
-
-    /**
-     * A public method to cancel a current interaction workflow from this manager.
-     * @param event - The event that initiates the cancellation
-     */
-    cancel(event: PIXI.FederatedEvent): void;
-
-    /**
-     * Reset the mouse manager.
-     */
-    reset(options?: MouseInteractionManager.ResetOptions): void;
-  }
-
-  namespace MouseInteractionManager {
-    interface Any extends AnyMouseInteractionManager {}
-    type AnyConstructor = typeof AnyMouseInteractionManager;
-
-    /** @privateRemarks The private class property is `#HANDLER_OUTCOME` singular, but the getter is `handlerOutcomes`, so the brand uses the plural*/
-    type HANDLER_OUTCOMES = Brand<number, "MouseInteractionManager.HANDLER_OUTCOMES">;
-
-    interface HandlerOutcomes {
-      /** -2: SKIPPED - the handler has been skipped by previous logic */
-      SKIPPED: -2 & MouseInteractionManager.HANDLER_OUTCOMES;
-
-      /** -1: DISALLOWED - the handler has dissallowed further process */
-      DISALLOWED: -1 & MouseInteractionManager.HANDLER_OUTCOMES;
-
-      /** 1: REFUSED - the handler callback has been processed and is refusing further process */
-      REFUSED: 1 & MouseInteractionManager.HANDLER_OUTCOMES;
-
-      /** 2: ACCEPTED - the handler callback has been processed and is accepting further process */
-      ACCEPTED: 2 & MouseInteractionManager.HANDLER_OUTCOMES;
-    }
-
-    type INTERACTION_STATES = Brand<number, "MouseInteractionManager.INTERACTION_STATES">;
-
-    interface InteractionStates {
-      NONE: 0 & MouseInteractionManager.INTERACTION_STATES;
-      HOVER: 1 & MouseInteractionManager.INTERACTION_STATES;
-      CLICKED: 2 & MouseInteractionManager.INTERACTION_STATES;
-      GRABBED: 3 & MouseInteractionManager.INTERACTION_STATES;
-      DRAG: 4 & MouseInteractionManager.INTERACTION_STATES;
-      DROP: 5 & MouseInteractionManager.INTERACTION_STATES;
-    }
-
-    /**
-     * @remarks The list of actions provided by foundry, minus `dragXCancel`, `unclickX`, and `longPress`, which do not check permissions
-     */
-    type PermissionAction =
-      | "clickLeft"
-      | "clickLeft2"
-      | "clickRight"
-      | "clickRight2"
-      | "dragLeftDrop"
-      | "dragLeftMove"
-      | "dragLeftStart"
-      | "dragRightDrop"
-      | "dragRightMove"
-      | "dragRightStart"
-      | "hoverIn"
-      | "hoverOut";
-
-    type PermissionFunction = (user: User.ConfiguredInstance, event: Event | PIXI.FederatedEvent) => boolean;
-
-    type Permissions = Partial<Record<PermissionAction, PermissionFunction | boolean>>;
-
-    /**
-     * @remarks The full list of possible callback actions.
-     *
-     * Three actions get additional, non-event arguments passed by Foundry:
-     * - `hoverIn` on all placeables takes `options: { hoverOutOthers: boolean }` to trigger hover-out behavior on sibling objects
-     *   - For Regions specifically, `hoverOut` takes an `options: { updateLegend: boolean }` object, and that key is also added to Region `hoverIn` options
-     * - `longPress` receives `origin: PIXI.Point`
-     */
-    type Action =
-      | PermissionAction
-      | "dragLeftCancel"
-      | "dragRightCancel"
-      | "unclickLeft"
-      | "unclickRight"
-      | "longPress";
-
-    /**
-     * @remarks Only three actions get additional, non-event arguments passed by Foundry:
-     * - `hoverIn` on all placeables takes `options: { hoverOutOthers: boolean }` to trigger hover-out behavior on sibling objects
-     *   - For Regions specifically, `hoverOut` takes an `options: { updateLegend: boolean }` object, and that key is also added to Region `hoverIn` options
-     * - `longPress` receives `origin: PIXI.Point`
-     */
-    type CallbackFunction = (event: Event | PIXI.FederatedEvent, ...args: any[]) => boolean | null | void;
-
-    type Callbacks = Partial<Record<Action, CallbackFunction>>;
-
-    /** @internal */
-    type _Options = NullishProps<{
-      /**
-       * @remarks If passed, will set `this.controlIcon` to `Object[target]`; in practice, this should only be `null` or `"controlIcon"`
-       * @privateRemarks Despite Foundry typing this as `PIXI.DisplayObject` its one use in practice is as `string | null`
-       */
-      target: string | null;
-
-      /**
-       * @remarks If falsey, gets replaced with `(canvas.dimensions.size / 4)`
-       */
-      dragResistance: number;
-
-      /**
-       * @remarks Undocumented. Used in the constructor as `this.viewId = (this.options.application ?? canvas.app).view.id`, never passed in practice
-       */
-      application: PIXI.Application;
-    }>;
-
-    /**
-     * Interaction options which configure handling workflows
-     */
-    interface Options extends _Options {}
-
-    /** @internal */
-    type _ResetOptions = NullishProps<{
-      /**
-       * Reset the interaction data?
-       * @defaultValue `true`
-       */
-      interactionData: boolean;
-
-      /**
-       * Reset the state?
-       * @defaultValue `true`
-       */
-      state: boolean;
-    }>;
-
-    interface ResetOptions extends _ResetOptions {}
-
-    interface InteractionData<T> {
-      origin?: PIXI.Point;
-      destination?: PIXI.Point;
-      object?: T;
-    }
-  }
-}
-
-declare abstract class AnyMouseInteractionManager extends MouseInteractionManager {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/core/interaction/ping.d.mts

@@ -1,81 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A class to manage a user ping on the canvas.
-   */
-  class Ping extends PIXI.Container {
-    /**
-     * @param origin  - The canvas coordinates of the origin of the ping.
-     * @param options - Additional options to configure the ping animation.
-     */
-    constructor(origin: Canvas.Point, options?: PingOptions);
-
-    options: PingOptions;
-
-    _color: Color;
-
-    /** @remarks `Ping#destroy`'s parameter must be an object if passed, as the body does `options.children = true` */
-    override destroy(options?: PIXI.IDestroyOptions): void;
-
-    /**
-     * Start the ping animation.
-     * @returns Returns true if the animation ran to completion, false otherwise.
-     * @privateRemarks This calls `CanvasAnimation.animate` with an empty attribute array for the first argument,
-     * meaning no chance of early return, so no `| void` in the return type
-     */
-    animate(): Promise<boolean>;
-
-    /**
-     * On each tick, advance the animation.
-     * @param dt        - The number of ms that elapsed since the previous frame.
-     * @param animation - The animation state.
-     */
-    protected _animateFrame(dt: number, animation: CanvasAnimationData): void;
-  }
-
-  namespace Ping {
-    interface Any extends AnyPing {}
-    type AnyConstructor = typeof AnyPing;
-
-    /** @internal */
-    type _Options = InexactPartial<{
-      /**
-       * The duration of the animation in milliseconds.
-       * @defaultValue `900`
-       * @remarks Can't be `null` because `options` is `mergeObject`ed with an object with this key,
-       * and the result is passed on to `CanvasAnimation.animate` in its options
-       */
-      duration: number | undefined;
-
-      /**
-       * The size of the ping graphic.
-       * @defaultValue `128`
-       * @remarks Can't be `null` or `undefined` because `options` is `mergeObject`ed with an object with this key.
-       * This value is not used in the base `Ping` class, but is used by subclasses to define radius and padding in
-       * ways where `undefined` produces `NaN` and values of `0` (ie, cast `null`) are nonsensical
-       */
-      size: number;
-
-      /**
-       * The color of the ping graphic.
-       * @defaultValue `#ff6400`
-       * @remarks Can't be `null` or `undefined` because `options` is `mergeObject`ed with an object with this key,
-       * and passing either to `Color.from` produces a `Color(NaN)`, which may cause breakage in subclasses or when
-       * passed to PIXI methods
-       */
-      color: Color.Source;
-
-      /**
-       * The name for the ping animation to pass to {@link CanvasAnimation.animate}.
-       */
-      name?: PropertyKey | undefined | null;
-    }>;
-  }
-
-  interface PingOptions extends Ping._Options {}
-}
-
-declare abstract class AnyPing extends Ping {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts

@@ -1,81 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A type of ping that points to a specific location.
-   */
-  class ChevronPing extends Ping {
-    /**
-     * @param origin  - The canvas coordinates of the origin of the ping.
-     * @param options - Additional options to configure the ping animation.
-     *                  (default: `{duration: 900, size: 128, color: "#ff6400"}`)
-     */
-    constructor(origin: Canvas.Point, options?: PingOptions);
-
-    /** @defaultValue `(this.options.size / 2) * .75` */
-    _r: number;
-
-    /**
-     * The inner ring is 3/4s the size of the outer.
-     * @defaultValue `this._r * .75`
-     */
-    _rInner: number;
-
-    /**
-     * The animation is split into three stages. First, the chevron fades in and moves downwards, then the rings fade
-     * in, then everything fades out as the chevron moves back up.
-     * Store the 1/4 time slice.
-     * @defaultValue `this.options.duration * .25`
-     */
-    _t14: number;
-
-    /**
-     * Store the 1/2 time slice.
-     * @defaultValue `this.options.duration * .5`
-     */
-    _t12: number;
-
-    /**
-     * Store the 3/4s time slice.
-     * @defaultValue `this._t14 * 3`
-     */
-    _t34: number;
-
-    /** @remarks Doesn't exist before the first `#_createRings()` call, usually via `#animate()` */
-    _inner?: PIXI.Graphics;
-
-    /** @remarks Doesn't exist before the first `#_createRings()` call, usually via `#animate()` */
-    _outer?: PIXI.Graphics;
-
-    /**
-     * The path to the chevron texture.
-     * @remarks Unusually for Foundry, this is referred to by `ChevronPing.`, not `this.constructor.`, in
-     * `#_loadChevron()`, which must therefore be overridden to use a different value in a subclass
-     * @privateRemarks Foundry marked `@private`.
-     */
-    static _CHEVRON_PATH: string;
-
-    override animate(): Promise<boolean>;
-
-    override _animateFrame(dt: number, animation: CanvasAnimationData): void;
-
-    /**
-     * Draw the outer and inner rings.
-     * @param a - The alpha.
-     * @privateRemarks Foundry marked `@private`
-     */
-    _drawRings(a: number): void;
-
-    /**
-     * Load the chevron texture.
-     * @privateRemarks Foundry marked `@private`
-     */
-    _loadChevron(): Promise<PIXI.Sprite>;
-
-    /**
-     * Draw the two rings that are used as part of the ping animation.
-     * @privateRemarks Foundry marked `@private`
-     */
-    _createRings(): [PIXI.Graphics, PIXI.Graphics];
-  }
-}

package/src/foundry/client/pixi/core/interaction/pings/index.d.mts

@@ -1,2 +0,0 @@
-import "./chevron.d.mts";
-import "./pulse.d.mts";

package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts

@@ -1,166 +0,0 @@
-import type { InexactPartial, NullishProps } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A type of ping that produces a pulsing animation.
-   */
-  class PulsePing extends Ping {
-    /**
-     * @param origin - The canvas coordinates of the origin of the ping.
-     * @param options - Additional options to configure the ping animation.
-     */
-    constructor(origin: Canvas.Point, options?: PulsePingOptions);
-
-    override options: PulsePingOptions;
-
-    _color2: Color;
-
-    /**
-     * The radius is half the diameter.
-     * @defaultValue `this.options.size / 2`
-     */
-    _r: number;
-
-    /**
-     * This is the radius that the rings initially begin at. It's set to 1/5th of the maximum radius.
-     * @defaultValue `this._r / 5`
-     */
-    _r0: number;
-
-    /**
-     * Initialize some time slice variables that will be used to control the animation.
-     *
-     * The animation for each ring can be separated into two consecutive stages.
-     * Stage 1: Fade in a white ring with radius r0.
-     * Stage 2: Expand radius outward. While the radius is expanding outward, we have two additional, consecutive
-     * animations:
-     *  Stage 2.1: Transition color from white to the configured color.
-     *  Stage 2.2: Fade out.
-     * 1/5th of the animation time is allocated to Stage 1. 4/5ths are allocated to Stage 2. Of those 4/5ths, 2/5ths
-     * are allocated to Stage 2.1, and 2/5ths are allocated to Stage 2.2.
-     */
-    protected _computeTimeSlices(): void;
-
-    override animate(): Promise<boolean>;
-
-    override _animateFrame(dt: number, animation: CanvasAnimationData): void;
-
-    /**
-     * Transition linearly from one color to another.
-     * @param from     - The color to transition from.
-     * @param to       - The color to transition to.
-     * @param duration - The length of the transition in milliseconds.
-     * @param t        - The current time along the duration.
-     * @returns The incremental color between from and to.
-     * @privateRemarks Foundry marked `@private`, and only types the return as `number`, instead of the more accurate `Color`
-     */
-    protected _colorTransition(from: Color, to: Color, duration: number, t: number): Color;
-
-    /**
-     * Draw the shape for this ping.
-     * @param g     - The graphics object to draw to.
-     * @param color - The color of the shape.
-     * @param alpha - The alpha of the shape.
-     * @param size  - The size of the shape to draw.
-     */
-    protected _drawShape(g: PIXI.Graphics, color: number | Color, alpha: number, size: number): void;
-  }
-
-  namespace PulsePing {
-    interface Any extends AnyPulsePing {}
-    type AnyConstructor = typeof AnyPulsePing;
-
-    /** @internal */
-    type _Options = InexactPartial<{
-      /**
-       * The number of rings used in the animation.
-       * @defaultValue `3`
-       * @remarks Can't be `null` as it only has a parameter default and a coerced `0` ring count is nonsensical
-       */
-      rings?: number;
-
-      /**
-       * The alternate color that the rings begin at. Use white for a 'flashing' effect.
-       * @defaultValue `#ffffff`
-       * @remarks Can't be `null` as it only has a parameter default and `Color(NaN)`s are to be avoided
-       */
-      color2?: Color.Source;
-    }>;
-  }
-
-  interface PulsePingOptions extends PingOptions, PulsePing._Options {}
-
-  /**
-   * A type of ping that produces an arrow pointing in a given direction.
-   */
-  class ArrowPing extends PulsePing {
-    /**
-     * @param origin - The canvas coordinates of the origin of the ping. This becomes the arrow's tip.
-     * @param options - Additional options to configure the ping animation.
-     */
-    constructor(origin: PIXI.Point, options?: ArrowPing.Options);
-
-    // @privateRemarks `options` does not get overridden here as the `rotation` key does not
-    // get passed up to super, so the property is still just `PulsePingOptions`
-
-    protected override _drawShape(g: PIXI.Graphics, color: number | Color, alpha: number, size: number): void;
-  }
-
-  namespace ArrowPing {
-    interface Any extends AnyArrowPing {}
-    type AnyConstructor = typeof AnyArrowPing;
-
-    /** @internal */
-    type _Options = NullishProps<{
-      /**
-       * The angle of the arrow in radians.
-       * @defaultValue `0`
-       * @privateRemarks Null coercion to `0` is fine here, as it's only added to then passed to `Math.normalizeRadians`
-       */
-      rotation: number;
-    }>;
-
-    interface Options extends PulsePingOptions, _Options {}
-  }
-
-  /**
-   * A type of ping that produces a pulse warning sign animation.
-   */
-  class AlertPing extends PulsePing {
-    /**
-     * @param origin  - The canvas coordinates of the origin of the ping.
-     * @param options - Additional options to configure the ping animation.
-     */
-    constructor(origin: PIXI.Point, options: AlertPing.Options);
-
-    protected override _drawShape(g: PIXI.Graphics, color: number | Color, alpha: number, size: number): void;
-  }
-
-  namespace AlertPing {
-    interface Any extends AnyAlertPing {}
-    type AnyConstructor = typeof AnyAlertPing;
-
-    /** @privateRemarks Only exists to change the default value of `color` */
-    interface Options extends PulsePingOptions {
-      /**
-       * @defaultValue `"#ff0000"`
-       * @remarks Can't be `null` or `undefined` because `options` is `mergeObject`ed with an object with this key,
-       * and passing either to `Color.from` produces a `Color(NaN)`, which may cause breakage in subclasses or when
-       * passed to PIXI methods
-       */
-      color?: PulsePingOptions["color"];
-    }
-  }
-}
-
-declare abstract class AnyPulsePing extends PulsePing {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyArrowPing extends ArrowPing {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyAlertPing extends AlertPing {
-  constructor(arg0: never, ...args: never[]);
-}