@7h3laughingman/foundry-types 13.351.0

package/src/client/canvas/layers/_types.d.mts

@@ -0,0 +1,89 @@
+import { SpriteMesh } from "../containers/_module.mjs";
+import PlaceableObject from "../placeables/placeable-object.mjs";
+import AmbientSound from "../placeables/sound.mjs";
+import PointSoundSource from "../sources/point-sound-source.mjs";
+import { ElevatedPoint } from "./../../../common/_types.mjs";
+import Sound from "./../../audio/sound.mjs";
+import { CanvasLayerOptions } from "./base/canvas-layer.mjs";
+
+export interface AmbientSoundPlaybackConfig {
+    /** The Sound node which should be controlled for playback */
+    sound: Sound;
+    /** The SoundSource which defines the area of effect for the sound */
+    source: PointSoundSource<AmbientSound>;
+    /** An AmbientSound object responsible for the sound, or undefined */
+    object?: AmbientSound;
+    /** The coordinates of the closest listener or undefined if there is none */
+    listener?: ElevatedPoint;
+    /** The minimum distance between a listener and the AmbientSound origin */
+    distance: number;
+    /** Is the closest listener muffled */
+    muffled: boolean;
+    /** Is playback constrained or muffled by walls? */
+    walls: boolean;
+    /** The final volume at which the Sound should be played */
+    volume: number;
+}
+
+export interface CanvasHistoryEvent<TData extends object = object> {
+    /** The type of operation stored as history */
+    type: "create" | "update" | "delete";
+    /** The data corresponding to the action which may later be un-done */
+    data: TData[];
+    /** The options of the undo operation */
+    options: object;
+}
+
+export interface PlaceablesLayerOptions extends CanvasLayerOptions {
+    /** Can placeable objects in this layer be controlled? */
+    controllableObjects: boolean;
+    /** Can placeable objects in this layer be rotated? */
+    rotatableObjects: boolean;
+    /** Confirm placeable object deletion with a dialog? */
+    confirmDeleteKey: boolean;
+    /** The class used to represent an object on this layer. */
+    objectClass: AbstractConstructorOf<PlaceableObject>;
+    /** Does this layer use a quadtree to track object positions? */
+    quadtree: boolean;
+}
+
+/**
+ * The sight part of {@link foundry.canvas.layers.types.CanvasVisionContainer}.
+ * The blend mode is MAX_COLOR.
+ */
+export interface CanvasVisionContainerSight extends PIXI.Graphics {
+    /** FOV that should not be committed to fog exploration. */
+    preview: PIXI.Graphics;
+}
+
+/**
+ * The light part of {@link foundry.canvas.layers.types.CanvasVisionContainer}.
+ * The blend mode is MAX_COLOR.
+ */
+export interface CanvasVisionContainerLight extends PIXI.Graphics {
+    /** FOV that should not be committed to fog exploration. */
+    preview: PIXI.Graphics;
+    /** The sprite with the texture of FOV of cached light sources. */
+    cached: SpriteMesh;
+    /** The light perception polygons of vision sources and the FOV of vision sources that provide vision. */
+    mask: CanvasVisionContainerSight;
+}
+
+/**
+ * The sight part of {@link foundry.canvas.layers.types.CanvasVisionContainer}.
+ * The blend mode is ERASE.
+ */
+export interface CanvasVisionContainerDarkness extends PIXI.Graphics {
+    /** Darkness source erasing fog of war. */
+    darkness: PIXI.Graphics;
+}
+
+/** The currently visible areas. */
+export interface CanvasVisionContainer extends PIXI.Container {
+    /** Areas visible because of light sources and light perception. */
+    light: CanvasVisionContainerLight;
+    /** Areas visible because of FOV of vision sources. */
+    sight: CanvasVisionContainerSight;
+    /** Areas visible because of FOV of vision sources. */
+    darkness: CanvasVisionContainerDarkness;
+}

package/src/client/canvas/layers/base/canvas-layer.d.mts

@@ -0,0 +1,71 @@
+/**
+ * An abstract pattern for primary layers of the game canvas to implement
+ */
+export default abstract class CanvasLayer extends PIXI.Container {
+    /** Options for this layer instance. */
+    options: CanvasLayerOptions;
+
+    /** Default interactivity */
+    interactiveChildren: boolean;
+
+    /* -------------------------------------------- */
+    /*  Layer Attributes                            */
+    /* -------------------------------------------- */
+
+    /** Customize behaviors of this CanvasLayer by modifying some behaviors at a class level. */
+    static get layerOptions(): CanvasLayerOptions;
+
+    /** Return a reference to the active instance of this canvas layer */
+    static get instance(): CanvasLayer;
+
+    /**
+     * The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the
+     * defined baseClass for the layer type.
+     *
+     * @example
+     * canvas.lighting.name -> "LightingLayer"
+     * canvas.grid.name -> "GridLayer"
+     */
+    get name(): string;
+
+    /**
+     * The name used by hooks to construct their hook string.
+     * Note: You should override this getter if hookName should not return the class constructor name.
+     */
+    get hookName(): string;
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    /**
+     * Draw the canvas layer, rendering its internal components and returning a Promise.
+     * The Promise resolves to the drawn layer once its contents are successfully rendered.
+     * @param options Options which configure how the layer is drawn
+     */
+    draw(options?: object): Promise<this>;
+
+    /**
+     * The inner _draw method which must be defined by each CanvasLayer subclass.
+     * @param options Options which configure how the layer is drawn
+     */
+    protected abstract _draw(options?: object): Promise<void>;
+
+    /**
+     * Deconstruct data used in the current layer in preparation to re-draw the canvas
+     * @param options Options which configure how the layer is deconstructed
+     */
+    tearDown(options?: object): Promise<this>;
+
+    /**
+     * The inner _tearDown method which may be customized by each CanvasLayer subclass.
+     * @param options Options which configure how the layer is deconstructed
+     */
+    protected _tearDown(options?: object): Promise<void>;
+}
+
+export interface CanvasLayerOptions {
+    name: string;
+    baseClass: string;
+    zIndex: number;
+}

package/src/client/canvas/layers/base/interaction-layer.d.mts

@@ -0,0 +1,176 @@
+import { SceneControl } from "./../../../applications/ui/scene-controls.mjs";
+import User from "./../../../documents/user.mjs";
+import CanvasLayer, { CanvasLayerOptions } from "./canvas-layer.mjs";
+
+/**
+ * A subclass of CanvasLayer which provides support for user interaction with its contained objects.
+ * @category Canvas
+ */
+export default class InteractionLayer extends CanvasLayer {
+    /** Is this layer currently active */
+    get active(): boolean;
+
+    override eventMode: "passive";
+
+    /** Customize behaviors of this CanvasLayer by modifying some behaviors at a class level. */
+    static get layerOptions(): CanvasLayerOptions;
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    /**
+     * Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.
+     * @param [options]     Options which configure layer activation
+     * @param options.tool  A specific tool in the control palette to set as active
+     * @returns The layer instance, now activated
+     */
+    activate(options?: { tool: string }): this;
+
+    /** The inner _activate method which may be defined by each InteractionLayer subclass. */
+    protected _activate(): void;
+
+    /**
+     * Deactivate the InteractionLayer, removing interactivity from its children.
+     * @returns The layer instance, now inactive
+     */
+    deactivate(): this;
+
+    /** The inner _deactivate method which may be defined by each InteractionLayer subclass. */
+    protected _deactivate(): void;
+
+    protected override _draw(options: object): Promise<void>;
+
+    /** Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container. */
+    getZIndex(): number;
+
+    /** Prepare data used by SceneControls to register tools used by this layer. */
+    static prepareSceneControls(): SceneControl | null;
+
+    /**
+     * Highlight the objects of this layer.
+     * @param active  Should the objects of this layer be highlighted?
+     */
+    protected _highlightObjects(active: boolean): void;
+
+    /* -------------------------------------------- */
+    /*  Event Listeners and Handlers                */
+    /* -------------------------------------------- */
+
+    /**
+     * Handle left mouse-click events which originate from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onClickLeft(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Handle double left-click events which originate from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onClickLeft2(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Does the User have permission to left-click drag on the Canvas?
+     * @param user   The User performing the action.
+     * @param event  The event object.
+     */
+    protected _canDragLeftStart(user: User, event: PIXI.FederatedEvent): boolean;
+
+    /**
+     * Start a left-click drag workflow originating from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onDragLeftStart(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Continue a left-click drag workflow originating from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onDragLeftMove(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Conclude a left-click drag workflow originating from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onDragLeftDrop(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Cancel a left-click drag workflow originating from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onDragLeftCancel(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Handle right mouse-click events which originate from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onClickRight(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Handle double right mouse-click events which originate from the Canvas stage.
+     * @param event  The PIXI InteractionEvent which wraps a PointerEvent
+     */
+    protected _onClickRight2(event: PIXI.FederatedEvent): void;
+
+    /**
+     * Handle mouse-wheel events which occur for this active layer.
+     * @param event  The WheelEvent initiated on the document
+     */
+    protected _onMouseWheel(event: WheelEvent): void;
+
+    /**
+     * Handle a Cycle View keypress while this layer is active.
+     * @param event  The cycle-view key press event
+     * @returns  Was the event handled?
+     */
+    protected _onCycleViewKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Delete keypress while this layer is active.
+     * @param event  The delete key press event
+     * @returns  Was the event handled?
+     */
+    protected _onDeleteKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Select All keypress while this layer is active.
+     * @param event  The select-all key press event
+     * @returns  Was the event handled?
+     */
+    protected _onSelectAllKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Dismiss keypress while this layer is active.
+     * @param event  The dismiss key press event
+     * @returns  Was the event handled?
+     */
+    protected _onDismissKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Undo keypress while this layer is active.
+     * @param event  The undo key press event
+     * @returns  Was the event handled?
+     */
+    protected _onUndoKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Cut keypress while this layer is active.
+     * @param event  The cut key press event
+     * @returns  Was the event handled?
+     */
+    protected _onCutKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Copy keypress while this layer is active.
+     * @param event  The copy key press event
+     * @returns  Was the event handled?
+     */
+    protected _onCopyKey(event: KeyboardEvent): boolean;
+
+    /**
+     * Handle a Paste keypress while this layer is active.
+     * @param event  The paste key press event
+     * @returns  Was the event handled?
+     */
+    protected _onPasteKey(event: KeyboardEvent): boolean;
+}