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

package/src/foundry/client-esm/canvas/regions/shape.d.mts

@@ -1,118 +0,0 @@
-import type { CircleShapeData, EllipseShapeData, PolygonShapeData, RectangleShapeData } from "../../data/_module.d.mts";
-
-declare namespace RegionShape {
-  type Any = RegionShape<any>;
-
-  type ShapeData = CircleShapeData | EllipseShapeData | PolygonShapeData | RectangleShapeData;
-  type ShapeType = ShapeData["type"];
-
-  type CreatedRegionShape<ShapeData extends RegionShape.ShapeData> = _CreateReturnType<ShapeData, ShapeData["type"]>;
-
-  /** @internal */
-  type _CreateReturnType<ShapeData extends RegionShape.ShapeData, ShapeType extends RegionShape.ShapeType> =
-    | (ShapeType extends "circle" ? RegionCircle<ShapeData> : never)
-    | (ShapeType extends "ellipse" ? RegionEllipse<ShapeData> : never)
-    | (ShapeType extends "polygon" ? RegionPolygon<ShapeData> : never)
-    | (ShapeType extends "rectangle" ? RegionRectangle<ShapeData> : never);
-}
-
-/** A shape of a {@link Region} */
-declare abstract class RegionShape<ShapeData extends RegionShape.ShapeData> {
-  #regionShape: true;
-
-  /**
-   * Create the RegionShape from the shape data.
-   * @param data    - The shape data.
-   */
-  constructor(data: ShapeData);
-
-  /**
-   * Create the RegionShape from the shape data.
-   * @param data    - The shape data.
-   */
-  static create<ShapeData extends RegionShape.ShapeData>(data: ShapeData): RegionShape.CreatedRegionShape<ShapeData>;
-
-  /**
-   * The data of this shape.
-   * It is owned by the shape and must not be modified.
-   */
-  get data(): ShapeData;
-
-  /** Is this a hole? */
-  get isHole(): boolean;
-
-  /**
-   * The Clipper paths of this shape.
-   * The winding numbers are 1 or 0.
-   */
-  get clipperPaths(): ReadonlyArray<ReadonlyArray<ClipperLib.IntPoint>>;
-
-  /** The Clipper polygon tree of this shape */
-  get clipperPolyTree(): ClipperLib.PolyTree;
-
-  /**
-   * Create the Clipper polygon tree of this shape.
-   * This function may return a single positively-orientated and non-selfintersecting Clipper path instead of a tree,
-   * which is automatically converted to a Clipper polygon tree.
-   * This function is called only once. It is not called if the shape is empty.
-   */
-  protected abstract _createClipperPolyTree(): ClipperLib.PolyTree | ClipperLib.IntPoint[];
-
-  /**
-   * Draw shape into the graphics.
-   * @param graphics      - The graphics to draw the shape into.
-   * @internal
-   */
-  protected abstract _drawShape(graphics: PIXI.Graphics): void;
-}
-
-/**
- * A circle of a {@link Region}
- * @privateRemarks Technically `ShapeData` should extend `CircleShapeData`, but it's easier to instantiate if it's `RegionShape.ShapeData`.
- */
-declare class RegionCircle<ShapeData extends RegionShape.ShapeData> extends RegionShape<ShapeData> {
-  #regionCircle: true;
-
-  constructor(data: ShapeData);
-
-  protected override _createClipperPolyTree(): ClipperLib.PolyTree | ClipperLib.IntPoint[];
-
-  protected override _drawShape(graphics: PIXI.Graphics): void;
-}
-/**
- * An ellipse of a {@link Region}
- * @privateRemarks Technically `ShapeData` should extend `EllipseShapeData`, but it's easier to instantiate if it's `RegionShape.ShapeData`.
- */
-declare class RegionEllipse<ShapeData extends RegionShape.ShapeData> extends RegionShape<ShapeData> {
-  #regionEllipse: true;
-
-  constructor(data: ShapeData);
-
-  protected override _createClipperPolyTree(): ClipperLib.PolyTree | ClipperLib.IntPoint[];
-
-  protected override _drawShape(graphics: PIXI.Graphics): void;
-}
-/**
- * A polygon of a {@link Region}
- * @privateRemarks Technically `ShapeData` should extend `PolygonShapeData`, but it's easier to instantiate if it's `RegionShape.ShapeData`.
- */
-declare class RegionPolygon<ShapeData extends RegionShape.ShapeData> extends RegionShape<ShapeData> {
-  constructor(params: ShapeData);
-
-  protected override _createClipperPolyTree(): ClipperLib.PolyTree | ClipperLib.IntPoint[];
-
-  protected override _drawShape(graphics: PIXI.Graphics): void;
-}
-/**
- * A rectangle of a {@link Region}
- * @privateRemarks Technically `ShapeData` should extend `RectangleShapeData`, but it's easier to instantiate if it's `RegionShape.ShapeData`.
- */
-declare class RegionRectangle<ShapeData extends RegionShape.ShapeData> extends RegionShape<ShapeData> {
-  constructor(params: ShapeData);
-
-  protected override _createClipperPolyTree(): ClipperLib.PolyTree | ClipperLib.IntPoint[];
-
-  protected override _drawShape(graphics: PIXI.Graphics): void;
-}
-
-export default RegionShape;

package/src/foundry/client-esm/canvas/scene-manager.d.mts

@@ -1,102 +0,0 @@
-/**
- * A framework for imbuing special scripted behaviors into a single specific Scene.
- * Managed scenes are registered in CONFIG.Canvas.managedScenes.
- *
- * The SceneManager instance is called at various points in the Scene rendering life-cycle.
- *
- * This also provides a framework for registering additional hook events which are required only for the life-cycle of
- * the managed Scene.
- *
- * @example Registering a custom SceneManager
- * ```js
- * // Define a custom SceneManager subclass
- * class MyCustomSceneManager extends SceneManager {
- *   async _onInit() {
- *     console.log(`Initializing managed Scene "${this.scene.name}"`);
- *   }
- *
- *   async _onDraw() {
- *     console.log(`Drawing managed Scene "${this.scene.name}"`);
- *   }
- *
- *   async _onReady() {
- *     console.log(`Readying managed Scene "${this.scene.name}"`);
- *   }
- *
- *   async _onTearDown() {
- *     console.log(`Deconstructing managed Scene "${this.scene.name}"`);
- *   }
- *
- *   _registerHooks() {
- *     this.registerHook("updateToken", this.#onUpdateToken.bind(this));
- *   }
- *
- *   #onUpdateToken(document, updateData, options, userId) {
- *     console.log("Updating a token within the managed Scene");
- *   }
- * }
- *
- * // Register MyCustomSceneManager to be used for a specific Scene
- * CONFIG.Canvas.sceneManagers = {
- *   [sceneId]: MyCustomSceneManager
- * }
- * ```
- */
-declare class SceneManager {
-  /**
-   * The SceneManager is constructed by passing a reference to the active Scene document.
-   */
-  constructor(scene: Scene);
-
-  /**
-   * The managed Scene
-   */
-  get scene(): Scene.ConfiguredInstance;
-
-  /**
-   * Additional behaviors to perform when the Canvas is first initialized for the Scene.
-   */
-  protected _onInit(): Promise<void>;
-
-  /**
-   * Additional behaviors to perform after core groups and layers are drawn to the canvas.
-   */
-  protected _onDraw(): Promise<void>;
-
-  /**
-   * Additional behaviors to perform after the Canvas is fully initialized for the Scene.
-   */
-  protected _onReady(): Promise<void>;
-
-  /**
-   * Additional behaviors to perform when the Scene is deactivated.
-   */
-  protected _onTearDown(): Promise<void>;
-
-  /**
-   * Register additional hook functions are only used while this Scene is active and is automatically deactivated.
-   * Hooks should be registered in this function by calling this._registerHook(hookName, handler)
-   */
-  protected _registerHooks(): void;
-
-  /**
-   * Register additional hook functions are only used while this Scene is active and is automatically deactivated.
-   */
-  registerHooks(hookName: string, handler: (...args: unknown[]) => unknown): void;
-
-  /**
-   * Deactivate Hook functions that were added specifically for this Scene.
-   */
-  protected _deactivateHooks(): void;
-}
-
-declare namespace SceneManager {
-  type Any = AnySceneManager;
-  type AnyConstructor = typeof AnySceneManager;
-}
-
-declare abstract class AnySceneManager extends SceneManager {
-  constructor(arg0: never, ...args: never[]);
-}
-
-export default SceneManager;

package/src/foundry/client-esm/canvas/smaa/blend.d.mts

@@ -1,6 +0,0 @@
-/**
- * The blending weight calculation filter for {@link foundry.canvas.SMAAFilter}.
- */
-export default class SMAABWeightCalculationFilter extends PIXI.Filter {
-  constructor(config: foundry.canvas.SMAAFilter.SMAAFilterConfig);
-}

package/src/foundry/client-esm/canvas/smaa/edges.d.mts

@@ -1,6 +0,0 @@
-/**
- * The edge detection filter for {@link foundry.canvas.SMAAFilter}.
- */
-export default class SMAAEdgeDetectionFilter extends PIXI.Filter {
-  constructor(config: foundry.canvas.SMAAFilter.SMAAFilterConfig);
-}

package/src/foundry/client-esm/canvas/smaa/smaa.d.mts

@@ -1,55 +0,0 @@
-import type { CLEAR_MODES, FilterState, FilterSystem, RenderTexture } from "pixi.js";
-
-import type { InexactPartial } from "fvtt-types/utils";
-
-declare class SMAAFilter extends PIXI.Filter {
-  /**
-   * @param config    - The config (defaults: SMAAFilter.PRESETS.DEFAULT)
-   */
-  constructor(config?: InexactPartial<SMAAFilter.SMAAFilterConfig>);
-
-  // a placeholder private method to help subclassing
-  #smaaFilter: true;
-
-  /**
-   * The presets.
-   */
-  static get PRESETS(): Record<string, SMAAFilter.SMAAFilterConfig>;
-
-  override apply(
-    filterManager: FilterSystem,
-    input: RenderTexture,
-    output: RenderTexture,
-    clearMode: CLEAR_MODES | undefined,
-    currentState: FilterState,
-  ): void;
-}
-
-declare namespace SMAAFilter {
-  interface SMAAFilterConfig {
-    /** Specifies the threshold or sensitivity to edges. Lowering this value you will be able to detect more edges at the expense of performance. Range: [0, 0.5]. 0.1 is a reasonable value, and allows to catch most visible edges. 0.05 is a rather overkill value, that allows to catch 'em all. */
-    threshold: number;
-
-    /** If there is an neighbor edge that has SMAA_LOCAL_CONTRAST_FACTOR times bigger contrast than current edge, current edge will be discarded.
-     *  This allows to eliminate spurious crossing edges, and is based on the fact that, if there is too much contrast in a direction, that will hide perceptually contrast in the other neighbors.
-     */
-    localContrastAdaptionFactor: number;
-
-    /** Specifies the maximum steps performed in the horizontal/vertical pattern searches, at each side of the pixel. In number of pixels, it's actually the double. So the maximum line length perfectly handled by, for example 16, is 64 (by perfectly, we meant that longer lines won't look as good, but still antialiased. Range: [0, 112]. */
-    maxSearchSteps: number;
-
-    /** Specifies the maximum steps performed in the diagonal pattern searches, at each side of the pixel. In this case we jump one pixel at time, instead of two. Range: [0, 20]. */
-    maxSearchStepsDiag: number;
-
-    /** Specifies how much sharp corners will be rounded. Range: [0, 100]. */
-    cornerRounding: number;
-
-    /** Is diagonal detection disabled? */
-    disableDiagDetection: boolean;
-
-    /** Is corner detection disabled? */
-    disableCornerDetection: boolean;
-  }
-}
-
-export default SMAAFilter;

package/src/foundry/client-esm/canvas/smaa/weights.d.mts

@@ -1,6 +0,0 @@
-/**
- * The neighborhood blending filter for {@link foundry.canvas.SMAAFilter}.
- */
-export default class SMAANeighborhoodBlendingFilter extends PIXI.Filter {
-  constructor();
-}

package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts

@@ -1,264 +0,0 @@
-import type { NullishProps, IntentionalPartial } from "fvtt-types/utils";
-
-/**
- * TODO - Re-document after ESM refactor.
- * An abstract base class which defines a framework for effect sources which originate radially from a specific point.
- * This abstraction is used by the LightSource, VisionSource, SoundSource, and MovementSource subclasses.
- *
- * @example A standard PointSource lifecycle:
- * ```js
- * const source = new PointSource({object}); // Create the point source
- * source.initialize(data);                  // Configure the point source with new data
- * source.refresh();                         // Refresh the point source
- * source.destroy();                         // Destroy the point source
- * ```
- * @privateRemarks The TODO is foundry's
- */
-declare abstract class BaseEffectSource<
-  SourceData extends BaseEffectSource.SourceData,
-  SourceShape extends PIXI.Polygon,
-> {
-  /**
-   * An effect source is constructed by providing configuration options.
-   * @param options - Options which modify the base effect source instance
-   * @remarks Passing a PlaceableObject is deprecated, and will be removed in v13
-   */
-  constructor(options?: BaseEffectSource.SourceOptions | PlaceableObject);
-
-  /**
-   * The type of source represented by this data structure.
-   * Each subclass must implement this attribute.
-   */
-  static sourceType: string;
-
-  /**
-   * The target collection into the effects canvas group.
-   */
-  static effectsCollection: string;
-
-  /**
-   * Effect source default data.
-   * @defaultValue
-   * ```js
-   * {
-   * x: 0,
-   * y: 0,
-   * elevation: 0,
-   * disabled: false
-   * }
-   * ```
-   */
-  static defaultData: BaseEffectSource.SourceData;
-
-  /**
-   * Some other object which is responsible for this source.
-   * @privateRemarks In Foundry practice this appears to only ever be `null`, `Token.ConfiguredInstance`, or `EffectsCanvasGroup` in v12
-   */
-  object: PlaceableObject.Any | CanvasGroupMixin.AnyMixed | null;
-
-  /**
-   * The source id linked to this effect source.
-   * @remarks Foundry types this as Readonly<string>, but does nothing to that effect at runtime
-   */
-  sourceId: string | undefined;
-
-  /**
-   * The data of this source.
-   */
-  data: SourceData;
-
-  /**
-   * The geometric shape of the effect source which is generated later.
-   * @remarks This only isn't `undefined` in subclasses implementing `_createShapes()`, usually via {@link PointEffectSourceMixin}
-   */
-  shape: SourceShape | undefined;
-
-  /**
-   * A collection of boolean flags which control rendering and refresh behavior for the source.
-   */
-  protected _flags: Record<string, boolean | number>;
-
-  /**
-   * The x-coordinate of the point source origin.
-   */
-  get x(): number;
-
-  /**
-   * The y-coordinate of the point source origin.
-   */
-  get y(): number;
-
-  /**
-   * The elevation bound to this source.
-   */
-  get elevation(): number;
-
-  /**
-   * The EffectsCanvasGroup collection linked to this effect source.
-   */
-  get effectsCollection(): foundry.utils.Collection<this>;
-
-  /**
-   * Returns the update ID associated with this source.
-   * The update ID is increased whenever the shape of the source changes.
-   */
-  get updateId(): number;
-
-  /**
-   * Is this source currently active?
-   * A source is active if it is attached to an effect collection and is not disabled or suppressed.
-   */
-  get active(): boolean;
-
-  /**
-   * Is this source attached to an effect collection?
-   */
-  get attached(): boolean;
-
-  /**
-   * Is this source temporarily suppressed?
-   */
-  get suppressed(): boolean;
-
-  /**
-   * Records of suppression strings with a boolean value.
-   * If any of this record is true, the source is suppressed.
-   */
-  suppression: Record<string, boolean>;
-
-  /**
-   * Initialize and configure the source using provided data.
-   * @param data    - Provided data for configuration
-   * @param options - Additional options which modify source initialization
-   * @returns The initialized source
-   */
-  initialize(
-    data?: NullishProps<SourceData>,
-    /** @privateRemarks Foundry describes an `options.behaviors` key, but it is neither checked for nor used at runtime */
-    options?: NullishProps<{
-      /**
-       * Should source data be reset to default values before applying changes?
-       * @defaultValue `false`
-       */
-      reset: boolean;
-    }>,
-  ): this;
-
-  /**
-   * Subclass specific data initialization steps.
-   * @param data - Provided data for configuration
-   */
-  _initialize(
-    /** @remarks IntentionalPartial because `this.initialize` has filtered invalid keys and replaced any nullish values before calling this */
-    data: IntentionalPartial<SourceData>,
-  ): void;
-
-  /**
-   * Create the polygon shape (or shapes) for this source using configured data.
-   */
-  protected _createShapes(): void;
-
-  /**
-   * Subclass specific configuration steps. Occurs after data initialization and shape computation.
-   * Only called if the source is attached and not disabled.
-   * @param changes - Changes to the source data which were applied
-   * @remarks This is actually passed *flattened* partial data
-   */
-  protected _configure(changes: IntentionalPartial<SourceData>): void;
-
-  /**
-   * Refresh the state and uniforms of the source.
-   * Only active sources are refreshed.
-   */
-  refresh(): void;
-
-  /**
-   * Subclass-specific refresh steps.
-   */
-  protected _refresh(): void;
-
-  /**
-   * Steps that must be performed when the source is destroyed.
-   */
-  destroy(): void;
-
-  /**
-   * Subclass specific destruction steps.
-   */
-  protected _destroy(): void;
-
-  /**
-   * Add this BaseEffectSource instance to the active collection.
-   */
-  add(): void;
-
-  /**
-   * Remove this BaseEffectSource instance from the active collection.
-   */
-  remove(): void;
-
-  /**
-   * @deprecated since v11, will be removed in v13
-   * @remarks `"BaseEffectSource#sourceType is deprecated. Use BaseEffectSource.sourceType instead."`
-   */
-  get sourceType(): string;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"BaseEffectSource#_createShape is deprecated in favor of BaseEffectSource#_createShapes."`
-   */
-  _createShape(): void;
-
-  /**
-   * @deprecated since v12, will be removed in v14
-   * @remarks `"BaseEffectSource#disabled is deprecated in favor of BaseEffectSource#data#disabled or BaseEffectSource#active depending on your use case."`
-   */
-  get disabled(): boolean;
-}
-
-declare namespace BaseEffectSource {
-  type AnyConstructor = typeof AnyBaseEffectSource;
-
-  /** @internal */
-  type _SourceOptions = NullishProps<{
-    /**
-     * An optional PlaceableObject which is responsible for this source
-     */
-    object: PlaceableObject;
-  }>;
-
-  interface SourceOptions extends _SourceOptions {
-    /**
-     * A unique ID for this source. This will be set automatically if an
-     * object is provided, otherwise is required.
-     * @remarks The above is misleading; sourceId will *not* be inferred if you pass in `{object: PlaceableObject}`,
-     * only if you pass a `PlaceableObject` *instead* of an options object to the constructor.
-     */
-    sourceId?: string;
-  }
-
-  interface SourceData {
-    /**
-     * The x-coordinate of the source location
-     */
-    x: number;
-    /**
-     * The y-coordinate of the source location
-     */
-    y: number;
-    /**
-     * The elevation of the point source
-     */
-    elevation: number;
-    /**
-     * Whether or not the source is disabled
-     */
-    disabled: boolean;
-  }
-}
-
-declare abstract class AnyBaseEffectSource extends BaseEffectSource<any, any> {
-  constructor(arg0: never, ...args: never[]);
-}
-
-export default BaseEffectSource;