@league-of-foundry-developers/foundry-vtt-types 9.268.0 → 9.269.0

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayer.d.ts

@@ -1,136 +0,0 @@
-import { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } 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>;
-
-    /**
-     * @override
-     * @remarks It returns Promise<this> but is overridden by a subclass in this way.
-     */
-    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>>);
-  }
-}
-
-interface MapLayerConstructorData {
-  bgPath?: string;
-  /**
-   * @defaultValue `1`
-   */
-  level?: number;
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/backgroundLayer.d.ts

@@ -1,43 +0,0 @@
-import {
-  ConfiguredDocumentClassForName,
-  ConfiguredObjectClassForName,
-  DataSourceForPlaceable
-} from '../../../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * 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;
-  }
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/foregroundLayer.d.ts

@@ -1,92 +0,0 @@
-import { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * 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]>;
-  }
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/index.d.ts

@@ -1,2 +0,0 @@
-import './backgroundLayer';
-import './foregroundLayer';

package/src/foundry/foundry.js/pixi/containers/index.d.ts

@@ -1,15 +0,0 @@
-import './baseGrid';
-import './baseGrids';
-import './cachedContainer';
-import './cachedContainers';
-import './canvasLayer';
-import './canvasLayers';
-import './controlIcon';
-import './cursor';
-import './doorControl';
-import './effectsCanvasGroup';
-import './interfaceCanvasGroup';
-import './objectHUD';
-import './placeableObject';
-import './placeableObjects';
-import './ruler';

package/src/foundry/foundry.js/pixi/filters/abstractBaseMaskFilter.d.ts

@@ -1,40 +0,0 @@
-/**
- * This class defines an interface for masked custom filters
- */
-declare abstract class AbstractBaseMaskFilter extends PIXI.Filter {
-  /**
-   * The default vertex shader used by all instances of AbstractBaseMaskFilter
-   */
-  static vertexShader: string;
-
-  /**
-   * The fragment shader which renders this filter.
-   * A subclass of AbstractBaseMaskFilter must implement the fragmentShader(channel) static field.
-   */
-  static fragmentShader: ((channel: 'r' | 'g' | 'b') => string) | null;
-
-  /**
-   * A factory method for creating the filter using its defined default values
-   * @param defaultUniforms - Initial uniforms provided to the filter
-   *                          (default: `{}`)
-   * @param channel         - A color channel to target for masking.
-   *                          (default: `'r'`)
-   */
-  static create<T extends AbstractBaseMaskFilter>(
-    this: ConstructorOf<T>,
-    defaultUniforms?: ConstructorParameters<typeof PIXI.Filter>[2],
-    channel?: 'r' | 'g' | 'b'
-  ): T;
-
-  /**
-   * @override
-   * @param currentState - (unused)
-   */
-  apply(
-    filterManager: PIXI.systems.FilterSystem,
-    input: PIXI.RenderTexture,
-    output: PIXI.RenderTexture,
-    clear: PIXI.CLEAR_MODES,
-    currentState: any
-  ): void;
-}

package/src/foundry/foundry.js/pixi/filters/abstractBaseMaskFilters/index.d.ts

@@ -1 +0,0 @@
-import './inverseOcclusionMaskFilter';

package/src/foundry/foundry.js/pixi/filters/abstractBaseMaskFilters/inverseOcclusionMaskFilter.d.ts

@@ -1,18 +0,0 @@
-/**
- * A filter used to control channels intensity using an externally provided mask texture.
- * The mask channel used must be provided at filter creation.
- * Contributed by SecretFire#4843
- */
-declare class InverseOcclusionMaskFilter extends AbstractBaseMaskFilter {
-  static fragmentShader(channel: 'r' | 'g' | 'b'): string;
-
-  /**
-   * @param defaultUniforms - (default: `{}`)
-   * @param channel  - (default `'r'`)
-   */
-  static create<T extends InverseOcclusionMaskFilter>(
-    this: ConstructorOf<T>,
-    defaultUniforms?: ConstructorParameters<typeof PIXI.Filter>[2],
-    channel?: 'r' | 'g' | 'b'
-  ): T;
-}

package/src/foundry/foundry.js/pixi/filters/abstractFilter.d.ts

@@ -1,42 +0,0 @@
-/**
- * An abstract filter which provides a framework for reusable definition
- */
-declare abstract class AbstractFilter extends PIXI.Filter {
-  /**
-   * The default uniforms used by the filter
-   * @defaultValue `{}`
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  /**
-   * The fragment shader which renders this filter.
-   * @defaultValue `undefined`
-   * @remarks This is a function in {@link GlowFilter}. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6937
-   */
-  static fragmentShader: string | ((quality: number, distance: number) => string) | undefined;
-
-  /**
-   * The vertex shader which renders this filter.
-   * @defaultValue `undefined`
-   */
-  static vertexShader: string | undefined;
-
-  /**
-   * A factory method for creating the filter using its defined default values
-   * @param uniforms - (default: `{}`)
-   */
-  static create(uniforms: AbstractBaseShader.Uniforms): AbstractFilter;
-
-  /**
-   * Always target the resolution of the render texture or renderer
-   */
-  // @ts-expect-error this is a property on PIXI.Filter
-  get resolution(): number;
-  set resolution(value: number);
-
-  /**
-   * Always target the MSAA level of the render texture or renderer
-   */
-  get multisample(): PIXI.MSAA_QUALITY;
-  set multisample(value: PIXI.MSAA_QUALITY);
-}

package/src/foundry/foundry.js/pixi/filters/abstractFilters/fogColorFilter.d.ts

@@ -1,16 +0,0 @@
-/**
- * A filter which is rendering explored color according to FoW intensity.
- */
-declare class FogColorFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   exploredColor: [1, 1, 1]
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}

package/src/foundry/foundry.js/pixi/filters/abstractFilters/forceColorFilter.d.ts

@@ -1,17 +0,0 @@
-/**
- * A filter which forces all non-transparent pixels to a specific color and transparency.
- */
-declare class ForceColorFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   color: [1, 1, 1],
-   *   alpha: 1.0
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}

package/src/foundry/foundry.js/pixi/filters/abstractFilters/glowFilter.d.ts

@@ -1,31 +0,0 @@
-/**
- * A filter which implements an inner or outer glow around the source texture.
- * Incorporated from https://github.com/pixijs/filters/tree/main/filters/glow
- */
-declare class GlowFilter extends AbstractFilter {
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * {
-   *   distance: 10,
-   *   innerStrength: 0,
-   *   glowColor: [1, 1, 1, 1],
-   *   quality: 0.1,
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms & { distance: number; quality: number };
-
-  /**
-   * @override
-   * @remarks This could change, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6937
-   */
-  static fragmentShader(quality: number, distance: number): string;
-
-  /** @override */
-  static vertexShader: string;
-
-  /** @override */
-  static create(uniforms: AbstractBaseShader.Uniforms): GlowFilter;
-}

package/src/foundry/foundry.js/pixi/filters/abstractFilters/index.d.ts

@@ -1,4 +0,0 @@
-import './fogColorFilter';
-import './forceColorFilter';
-import './glowFilter';
-import './roofMaskFilter';

package/src/foundry/foundry.js/pixi/filters/abstractFilters/roofMaskFilter.d.ts

@@ -1,20 +0,0 @@
-/**
- * This filter turns pixels with an alpha channel < alphaThreshold in transparent pixels
- * Then, optionally, it can turn the result in the chosen color (default: pure white).
- * The alpha [threshold,1] is re-mapped to [0,1] with an hermite interpolation slope to prevent pixelation.
- */
-declare class RoofMaskFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   alphaThreshold: 0.75,
-   *   turnToColor: false,
-   *   color: [1, 1, 1]
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}

package/src/foundry/foundry.js/pixi/filters/index.d.ts

@@ -1,4 +0,0 @@
-import './abstractBaseMaskFilter';
-import './abstractBaseMaskFilters';
-import './abstractFilter';
-import './abstractFilters';

package/src/foundry/foundry.js/pixi/graphics/index.d.ts

@@ -1,2 +0,0 @@
-import './gridHighlight';
-import './resizeHandle';

package/src/foundry/foundry.js/pixi/index.d.ts

@@ -1,11 +0,0 @@
-import './blendModes';
-import './containers';
-import './filters';
-import './graphics';
-import './meshes';
-import './points';
-import './polygons';
-import './rectangles';
-import './shaders';
-import './texts';
-import './transforms';

package/src/foundry/foundry.js/pixi/meshes/index.d.ts

@@ -1 +0,0 @@
-import './samplerMesh';

package/src/foundry/foundry.js/pixi/points/index.d.ts

@@ -1 +0,0 @@
-import './wallEndpoint';

package/src/foundry/foundry.js/pixi/points/wallEndpoint.d.ts

@@ -1,92 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A special subclass of PIXI.Point which is used for modeling Wall endpoints.
-   * A wall endpoint must have integer coordinates.
-   *
-   * This was used for the RadialSweepPolygon but can now be deleted once that is
-   * @deprecated since v9d2
-   */
-  class WallEndpoint extends PIXI.Point {
-    /**
-     * @param x - The integer x-coordinate
-     * @param y - The integer y-coordinate
-     */
-    constructor(x: number, y: number);
-
-    /**
-     * Express the point as a 32-bit integer with 16 bits allocated to x and 16 bits allocated to y
-     */
-    key: number;
-
-    /**
-     * The angle between this point and the polygon origin
-     * @defaultValue `undefined`
-     */
-    angle: number | undefined;
-
-    /**
-     * Record the set of walls which connect to this Endpoint
-     */
-    walls: Set<ConfiguredObjectClassForName<'Wall'>>;
-
-    /**
-     * Record whether this point is the endpoint of any Wall
-     * @defaultValue `false`
-     */
-    isEndpoint: boolean;
-
-    /**
-     * Record whether this point is a midpoint of any wall?
-     * @defaultValue `false`
-     */
-    isMidpoint: boolean;
-
-    /**
-     * Record whether this point is the termination of the Ray
-     * @defaultValue `false`
-     */
-    isTerminal: boolean;
-
-    /**
-     * Aggregate the maximum of each wall restriction type
-     */
-    types: Record<foundry.CONST.WALL_RESTRICTION_TYPES, number>;
-
-    /**
-     * An intermediate variable used to store the proportional distance of this point from a SightRay origin
-     * @defaultValue `undefined`
-     */
-    protected _r: number | undefined;
-
-    /**
-     * An intermediate variable used to cache the continuation attributes for a certain point
-     * @defaultValue `undefined`
-     */
-    protected _c: { left: boolean; right: boolean } | undefined;
-
-    attachWall(wall: ConfiguredObjectClassForName<'Wall'>): this;
-
-    /**
-     * Does this endpoint equal some other endpoint?
-     * @param other - Some other point with x and y coordinates
-     * @returns Are the points equal?
-     */
-    equals(other: Point): boolean;
-
-    /**
-     * Is this point one that provides only limited perspective?
-     * @param type - The perspective type being tested
-     * @returns Is perspective limited?
-     */
-    isLimited(type: foundry.CONST.WALL_RESTRICTION_TYPES): boolean;
-
-    /**
-     * Encode a x/y coordinate as a 32-bit integer
-     * @param x - The x-coordinate
-     * @param y - The y-coordinate
-     */
-    static getKey(x: number, y: number): number;
-  }
-}

package/src/foundry/foundry.js/pixi/polygons/index.d.ts

@@ -1,2 +0,0 @@
-import './pointSourcePolygon';
-import './pointSourcePolygons';

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/index.d.ts

@@ -1 +0,0 @@
-import './clockwiseSweepPolygon';

package/src/foundry/foundry.js/pixi/rectangles/index.d.ts

@@ -1 +0,0 @@
-import './normalizedRectangle';