@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

package/src/foundry/client/pixi/layers/lighting.d.ts

@@ -1,229 +0,0 @@
-/**
- * The Lighting Layer which displays darkness and light within the rendered Scene.
- * Lighting Layer (Container)
- *   Illumination Container [MULTIPLY]
- *     Background (Graphics)
- *     Light (Container) [LOS Mask]
- *       Source 1, ..., Source N (Container)
- *     Darkness (Container)
- *       Source 1, ..., Source N (Container)
- *   Coloration Container [ADD_NPM]
- *
- * @example <caption>The lightingRefresh hook</caption>
- * ```typescript
- * Hooks.on("lightingRefresh", layer => {});
- * ```
- */
-declare class LightingLayer extends PlaceablesLayer<'AmbientLight', LightingLayer.LayerOptions> {
-  constructor();
-
-  /**
-   * A mapping of light sources which are active within the rendered Scene
-   */
-  sources: foundry.utils.Collection<LightSource>;
-
-  /**
-   * Increment this whenever lighting channels are re-configured.
-   * This informs lighting and vision sources whether they need to re-render.
-   * @defaultValue `0`
-   */
-  version: number;
-
-  /**
-   * The currently displayed darkness level, which may override the saved Scene value
-   * @defaultValue `0`
-   */
-  darknessLevel: number;
-
-  /**
-   * The current client setting for whether global illumination is used or not
-   * @defaultValue `false`
-   */
-  globalLight: boolean;
-
-  /**
-   * The coloration container which visualizes the effect of light sources
-   * @defaultValue `null`
-   */
-  coloration: PIXI.Container | null;
-
-  /**
-   * The illumination container which visualizes darkness and light
-   * @defaultValue `null`
-   */
-  illumination: PIXI.Container | null;
-
-  /**
-   * The background container which visualizes the background
-   * @defaultValue `null`
-   */
-  background: PIXI.Container | null;
-
-  /**
-   * An array of light sources which are currently animated
-   * @internal
-   */
-  protected _animatedSources: LightSource[];
-
-  /**
-   * A mapping of different light level channels
-   * @defaultValue `undefined`
-   */
-  channels: ChannelConfig | undefined;
-
-  static override documentName: 'AmbientLight';
-
-  /**
-   * @remarks This is not overridden in foundry but reflects the real behavior.
-   */
-  static get instance(): Canvas['lighting'];
-
-  /**
-   * @defaultValue
-   * ```
-   * foundry.utils.mergeObject(super.layerOptions, {
-   *  name: "lighting",
-   *  rotatableObjects: true,
-   *  zIndex: 300
-   * })
-   * ```
-   */
-  static override get layerOptions(): LightingLayer.LayerOptions;
-
-  /**
-   * TODO: Significant portions of this method may no longer be needed
-   * Configure the lighting channels which are inputs to the ShadowMap
-   * @internal
-   */
-  protected _configureChannels({
-    darkness,
-    backgroundColor
-  }?: {
-    /** Darkness level override. */
-    darkness?: number;
-
-    /** Canvas background color override. */
-    backgroundColor?: number;
-  }): ChannelConfig;
-
-  override draw(): Promise<this>;
-
-  masks?: PIXI.Container;
-
-  /**
-   * Draw the coloration container which is responsible for rendering the visible hue of a light source.
-   * Apply an additive blend to the entire container after each individual light source is blended via screen.
-   * @internal
-   */
-  protected _drawColorationContainer(): PIXI.Container;
-
-  /**
-   * Draw the illumination container which is responsible for displaying darkness and light.
-   * @internal
-   */
-  protected _drawIlluminationContainer(): PIXI.Container;
-
-  /**
-   * Draw the background container which is responsible for displaying altered background.
-   * @internal
-   */
-  protected _drawBackgroundContainer(): PIXI.Container;
-
-  /**
-   * Does this scene currently benefit from global illumination?
-   */
-  hasGlobalIllumination(): boolean;
-
-  /**
-   * Initialize all AmbientLight sources which are present on this layer
-   */
-  initializeSources(): void;
-
-  /**
-   * Refresh the active display of the LightingLayer.
-   * Update the scene background color, light sources, and darkness sources
-   */
-  refresh({
-    darkness,
-    backgroundColor
-  }?: {
-    /**
-     * An override darkness level to which the layer should be temporarily
-     * rendered.
-     */
-    darkness?: number;
-
-    /** An override canvas background color. */
-    backgroundColor?: number;
-  }): void;
-
-  override tearDown(): Promise<this>;
-
-  /**
-   * Activate light source animation for AmbientLight objects within this layer
-   */
-  activateAnimation(): void;
-
-  /**
-   * Deactivate light source animation for AmbientLight objects within this layer
-   */
-  deactivateAnimation(): void;
-
-  /**
-   * The ticker handler which manages animation delegation
-   * @param dt - Delta time
-   * @internal
-   */
-  protected _animateSource(dt: number): void;
-
-  /**
-   * Animate a smooth transition of the darkness overlay to a target value.
-   * Only begin animating if another animation is not already in progress.
-   * @param target   - The target darkness level between 0 and 1
-   *                   (default: `1.0`)
-   * @returns A Promise which resolves once the animation is complete
-   */
-  animateDarkness(
-    target?: number,
-    {
-      duration
-    }?: {
-      /**
-       * The desired animation time in milliseconds. Default is 10 seconds
-       * @defaultValue `10000`
-       */
-      duration?: number;
-    }
-  ): Promise<void>;
-
-  /**
-   * Actions to take when the darkness level of the Scene is changed
-   * @param darkness - The new darkness level
-   * @param prior    - The prior darkness level
-   * @internal
-   */
-  protected _onDarknessChange(darkness: number, prior: number): void;
-
-  protected override _onDragLeftStart(event: PIXI.InteractionEvent): Promise<AmbientLight>;
-
-  protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-  protected override _onDragLeftCancel(event: PointerEvent): void;
-
-  protected override _onMouseWheel(event: WheelEvent): void | ReturnType<AmbientLight['rotate']>;
-}
-
-declare namespace LightingLayer {
-  interface LayerOptions extends PlaceablesLayer.LayerOptions<'AmbientLight'> {
-    name: 'lighting';
-  }
-}
-
-type ChannelConfig = Record<'canvas' | 'background' | 'black' | 'bright' | 'dark' | 'dim', LightChannel> & {
-  darkness: { level: number; rgb: [r: number, g: number, b: number] };
-};
-
-interface LightChannel {
-  hex: number;
-  rgb: [r: number, g: number, b: number];
-}

package/src/foundry/client/pixi/layers/map.d.ts

@@ -1,263 +0,0 @@
-import {
-  ConfiguredDocumentClassForName,
-  ConfiguredObjectClassForName,
-  DataSourceForPlaceable
-} from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A PlaceablesLayer designed for rendering the visual Scene for a specific vertical cross-section.
-   * Each MapLayer contains a single background image as well as an arbitrary number of Tile objects.
-   */
-  class MapLayer<Options extends MapLayer.LayerOptions = MapLayer.LayerOptions<'background'>> extends PlaceablesLayer<
-    'Tile',
-    Options
-  > {
-    /**
-     * @param data - (default: `{}`)
-     */
-    constructor(data?: MapLayerConstructorData);
-
-    /**
-     * The numeric Scene level to which this layer belongs
-     */
-    level: number;
-
-    /**
-     * The background source path
-     */
-    bgPath: string | undefined;
-
-    /**
-     * The layer background image
-     */
-    bg: PIXI.Sprite | undefined;
-
-    static documentName: 'Tile';
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     * It returns the BackgroundLayer but ForegroundLayer has been added for subclasses.
-     */
-    static get instance(): Canvas['background'] | Canvas['foreground'];
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *   name: 'background',
-     *   zIndex: 0,
-     *   controllableObjects: true,
-     *   rotatableObjects: true
-     * })
-     * ```
-     */
-    static get layerOptions(): MapLayer.LayerOptions;
-
-    /**
-     * Return the base HTML image or video element which is used to generate the background Sprite.
-     */
-    get bgSource(): HTMLImageElement | HTMLVideoElement | null;
-
-    get hud(): TileHUD;
-
-    /**
-     * Is the background texture used in this layer a video?
-     */
-    get isVideo(): boolean;
-
-    /**
-     * An array of Tile objects which are rendered within the objects container
-     */
-    get tiles(): InstanceType<ConfiguredObjectClassForName<'Tile'>>[];
-
-    deactivate(): this;
-
-    tearDown(): Promise<this>;
-
-    /**
-     * @remarks It returns Promise<this> but is overridden by a subclass in this way.
-     */
-    override draw(): Promise<this | undefined>;
-
-    /**
-     * Draw the background Sprite for the layer, aligning its dimensions with those configured for the canvas.
-     * @returns The rendered Sprite, or undefined if no background is present
-     */
-    protected _drawBackground(): PIXI.Sprite | undefined;
-
-    protected _onDragLeftStart(event: PIXI.InteractionEvent): Promise<void>;
-
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-    protected _onDragLeftDrop(event: PIXI.InteractionEvent): void;
-
-    protected _onDragLeftCancel(event: PointerEvent): void;
-
-    /**
-     * Handle drop events for Tile data on the Tiles Layer
-     * @param event - The concluding drag event
-     * @param data - The extracted Tile data
-     */
-    protected _onDropData(
-      event: DragEvent,
-      data:
-        | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-        | ({ type: string } & Partial<Record<string, unknown>>)
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Tile'>> | undefined>;
-
-    /**
-     * Prepare the data object when a new Tile is dropped onto the canvas
-     * @param event - The concluding drag event
-     * @param data  - The extracted Tile data
-     * @returns The prepared data to create
-     */
-    protected _getDropData(
-      event: DragEvent,
-      data: MapLayer.DropData
-    ): Promise<ConstructorParameters<typeof foundry.documents.BaseTile>[0]>;
-  }
-
-  namespace MapLayer {
-    interface LayerOptions<Name extends 'background' | 'foreground' = 'background' | 'foreground'>
-      extends PlaceablesLayer.LayerOptions<'Tile'> {
-      name: Name;
-    }
-
-    type DropData =
-      | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-      | ({ type: string } & Partial<Record<string, unknown>>);
-  }
-
-  /**
-   * An extension of the MapLayer that displays underfoot in the background of the Scene.
-   */
-  class BackgroundLayer extends MapLayer {
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas['background'];
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get layerOptions(): MapLayer.LayerOptions<'background'>;
-
-    /**
-     * The outline of the scene.
-     * Not rendered within the BackgroundLayer, but rather beneath it so it does not impact the PrimaryMesh texture.
-     */
-    outline: PIXI.Graphics | undefined;
-
-    /**
-     * Draw a background outline which emphasizes what portion of the canvas is playable space and what is buffer.
-     * @param outline - The outline graphics to use
-     */
-    drawOutline(outline: PIXI.Graphics): void;
-
-    getDocuments(): Exclude<this['documentCollection'], null> | InstanceType<ConfiguredDocumentClassForName<'Tile'>>[];
-
-    getZIndex(): number;
-
-    storeHistory(
-      type: PlaceablesLayer.HistoryEventType,
-      data: DataSourceForPlaceable<InstanceType<ConfiguredObjectClassForName<'Tile'>>>
-    ): void;
-  }
-
-  /**
-   * An extension of the MapLayer that displays overhead in the foreground of the Scene.
-   */
-  class ForegroundLayer extends MapLayer<MapLayer.LayerOptions<'foreground'>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *   name: "foreground"
-     * })
-     * ```
-     */
-    static get layerOptions(): MapLayer.LayerOptions<'foreground'>;
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas['foreground'];
-
-    /**
-     * Get an array of overhead Tile objects which are roofs
-     */
-    get roofs(): InstanceType<ConfiguredObjectClassForName<'Tile'>>[];
-
-    /**
-     * Determine whether to display roofs
-     */
-    get displayRoofs(): boolean;
-
-    draw(): Promise<undefined>;
-
-    /**
-     * Draw the container used to cache the position of Token occlusion shapes to a RenderTexture
-     */
-    protected _drawOcclusionMask(): CachedContainer;
-
-    /**
-     * Perform one-time initialization actions which affect the foreground layer.
-     * These actions presume and require that the layer has already been drawn.
-     */
-    initialize(): void;
-
-    override activate(): this;
-
-    deactivate(): this;
-
-    tearDown(): Promise<this>;
-
-    getZIndex(): number;
-
-    getDocuments(): Exclude<this['documentCollection'], null> | InstanceType<ConfiguredDocumentClassForName<'Tile'>>[];
-
-    /**
-     * Refresh the display of tiles on the Foreground Layer depending on Token occlusion.
-     */
-    refresh(): void;
-
-    /**
-     * Add a roof sprite to the occlusion roof mask container
-     * @param tile - The roof tile being added
-     */
-    addRoofSprite(tile: InstanceType<ConfiguredObjectClassForName<'Tile'>>): void;
-
-    /**
-     * Remove a roof sprite from occlusion roof mask container
-     * @param tile - The roof tile being removed
-     */
-    removeRoofSprite(tile: InstanceType<ConfiguredObjectClassForName<'Tile'>>): void;
-
-    /**
-     * Update occlusion for all tiles on the foreground layer
-     */
-    updateOcclusion(): void;
-
-    /**
-     * Draw the container which caches token-based occlusion shapes
-     * @param tokens - The set of currently observed tokens
-     */
-    protected _drawOcclusionShapes(tokens: ConfiguredObjectClassForName<'Token'>[]): void;
-
-    protected _getDropData(
-      event: DragEvent,
-      data:
-        | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-        | ({ type: string } & Partial<Record<string, unknown>>)
-    ): Promise<ConstructorParameters<typeof foundry.documents.BaseTile>[0]>;
-  }
-}
-
-interface MapLayerConstructorData {
-  bgPath?: string;
-  /**
-   * @defaultValue `1`
-   */
-  level?: number;
-}

package/src/foundry/client/pixi/layers/notes.d.ts

@@ -1,64 +0,0 @@
-import { DropData } from '../../data/abstract/client-document';
-
-declare global {
-  /**
-   * The Notes Layer which contains Note canvas objects
-   */
-  class NotesLayer extends PlaceablesLayer<'Note', NotesLayer.LayerOptions> {
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas['notes'];
-
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *  name: 'notes',
-     *  canDragCreate: false,
-     *  sortActiveTop: true,
-     *  zIndex: 60
-     * })
-     * ```
-     */
-    static override get layerOptions(): NotesLayer.LayerOptions;
-
-    static override documentName: 'Note';
-
-    /**
-     * The named core setting which tracks the toggled visibility state of map notes
-     */
-    static TOGGLE_SETTING: 'notesDisplayToggle';
-
-    override activate(): this;
-
-    override deactivate(): this;
-
-    /**
-     * Register game settings used by the NotesLayer
-     */
-    static registerSettings(): void;
-
-    /** @remarks this method seems to be unused, see https://gitlab.com/foundrynet/foundryvtt/-/issues/7004 */
-    protected _onMouseDown(event: PIXI.InteractionEvent): void;
-
-    /**
-     * Handle JournalEntry document drop data
-     */
-    protected _onDropData(event: DragEvent, data: DropData<JournalEntry>): Promise<false | void>;
-  }
-
-  namespace NotesLayer {
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<'Note'> {
-      name: 'notes';
-      canDragCreate: false;
-      sortActiveTop: true;
-      zIndex: 60;
-    }
-
-    type DropData = {
-      type?: 'JournalEntry';
-    } & Canvas.DropPosition &
-      DeepPartial<any>; // TODO: Update this
-  }
-}