@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

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

@@ -1,116 +0,0 @@
-/**
- * The DrawingsLayer subclass of PlaceablesLayer.
- * This layer implements a container for drawings which are rendered immediately above the BackgroundLayer.
- */
-declare class DrawingsLayer extends PlaceablesLayer<'Drawing', DrawingsLayer.LayerOptions> {
-  /**
-   * @remarks This is not overridden in foundry but reflects the real behavior.
-   */
-  static get instance(): Canvas['drawings'];
-
-  /**
-   * @defaultValue
-   * ```
-   * mergeObject(super.layerOptions, {
-   *   name: "drawings"
-   *   canDragCreate: true,
-   *   controllableObjects: true,
-   *   rotatableObjects: true,
-   *   zIndex: 20
-   * })
-   * ```
-   */
-  static override get layerOptions(): DrawingsLayer.LayerOptions;
-
-  static override documentName: 'Drawing';
-
-  /**
-   * The named game setting which persists default drawing configuration for the User
-   */
-  static DEFAULT_CONFIG_SETTING: 'defaultDrawingConfig';
-
-  /**
-   * Use an adaptive precision depending on the size of the grid
-   */
-  get gridPrecision(): 0 | 8 | 16;
-
-  override get hud(): Exclude<Canvas['hud'], null>['drawing'];
-
-  /**
-   * Render a configuration sheet to configure the default Drawing settings
-   */
-  configureDefault(): void;
-
-  /**
-   * Override the deactivation behavior of this layer.
-   * Placeables on this layer remain visible even when the layer is inactive.
-   */
-  deactivate(): this;
-
-  /**
-   * Get initial data for a new drawing.
-   * Start with some global defaults, apply user default config, then apply mandatory overrides per tool.
-   * @param origin - The initial coordinate
-   * @returns The new drawing data
-   * @remarks This is used from DrawingConfig and hence public on purpose.
-   */
-  _getNewDrawingData(origin: Point | {}): NewDrawingData;
-
-  protected override _onClickLeft(event: PIXI.InteractionEvent): void;
-
-  protected override _onClickLeft2(event: PIXI.InteractionEvent): void | Promise<void>;
-
-  protected override _onDragLeftStart(event: PIXI.InteractionEvent): ReturnType<Drawing['draw']>;
-
-  protected override _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handling of mouse-up events which conclude a new object creation after dragging
-   */
-  protected _onDragLeftDrop(event: PIXI.InteractionEvent): Promise<void>;
-
-  protected override _onDragLeftCancel(event: PointerEvent): void;
-
-  protected override _onClickRight(event: PIXI.InteractionEvent): void;
-}
-
-declare namespace DrawingsLayer {
-  interface LayerOptions extends PlaceablesLayer.LayerOptions<'Drawing'> {
-    name: 'drawings';
-    canDragCreate: true;
-    controllableObjects: true;
-    rotatableObjects: true;
-    zIndex: 20;
-  }
-}
-
-type NewDrawingData = ClientSettings.Values['core.defaultDrawingConfig'] &
-  (
-    | {
-        type: typeof foundry.CONST.DRAWING_TYPES.RECTANGLE | typeof foundry.CONST.DRAWING_TYPES.ELLIPSE;
-        points: [];
-      }
-    | {
-        type: typeof foundry.CONST.DRAWING_TYPES.POLYGON;
-        points: PointArray[];
-      }
-    | {
-        type: typeof foundry.CONST.DRAWING_TYPES.FREEHAND;
-        points: PointArray[];
-        bezierFactor: number;
-      }
-    | {
-        type: typeof foundry.CONST.DRAWING_TYPES.TEXT;
-        fillColor: string;
-        fillAlpha: number;
-        strokeColor: string;
-        text: string;
-      }
-  ) & {
-    author: string;
-    fillColor: string;
-    strokeColor: string;
-    fontFamily: typeof CONFIG.defaultFontFamily;
-    x: number | undefined;
-    y: number | undefined;
-  };

package/src/foundry/client/pixi/layers/effects/effect.d.ts

@@ -1,133 +0,0 @@
-/**
- * TODO: Document Me
- */
-declare class SpecialEffect {
-  constructor(parent: PIXI.Container, options?: DeepPartial<SpecialEffect.Options>);
-
-  parent: PIXI.Container;
-
-  options: SpecialEffect.Options;
-
-  emitters: PIXI.particles.Emitter[];
-
-  /**
-   * Use this flag as a way to pass a stop signal into the animation frame
-   * @internal
-   */
-  protected _stop: boolean | null;
-
-  static OPTION_TYPES: {
-    VALUE: 1;
-    CHECKBOX: 2;
-    RANGE: 3;
-    SELECT: 4;
-  };
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   maxSpeed: 0,
-   *   noRotation: false,
-   *   blendMode: 'normal',
-   *   emitterLifetime: -1,
-   *   pos: {
-   *     x: 0,
-   *     y: 0
-   *   },
-   *   spawnType: 'rect'
-   * }
-   * ```
-   */
-  static DEFAULT_CONFIG: PIXI.particles.EmitterConfig | PIXI.particles.OldEmitterConfig;
-
-  /**
-   * @defaultValue `'Special Effect'`
-   */
-  static get label(): string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   density: {
-   *     label: "Particle Density",
-   *     type: this.OPTION_TYPES.RANGE,
-   *     value: 0.5,
-   *     min: 0.1,
-   *     max: 5,
-   *     step: 0.1
-   *   }
-   * }
-   * ```
-   */
-  static get effectOptions(): SpecialEffect.Options;
-
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  play(duration: number): void;
-
-  stop(): void;
-
-  /**
-   * @internal
-   */
-  protected _startEmitter(emitter: PIXI.particles.Emitter): void;
-}
-
-declare namespace SpecialEffect {
-  interface Options {
-    density: {
-      /**
-       * @defaultValue `'Particle Density'`
-       */
-      label: string;
-
-      /**
-       * @defaultValue `SpecialEffect.OPTION_TYPES.RANGE`
-       */
-      type: ValueOf<typeof SpecialEffect['OPTION_TYPES']>;
-
-      /**
-       * @defaultValue `0.5`
-       */
-      value: number;
-
-      /**
-       * @defaultValue `0.1`
-       */
-      min: number;
-
-      /**
-       * @defaultValue `5`
-       */
-      max: number;
-
-      /**
-       * @defaultValue `0.1`
-       */
-      step: number;
-    };
-  }
-
-  type BlendMode =
-    | 'normal'
-    | 'add'
-    | 'multiply'
-    | 'screen'
-    | 'overlay'
-    | 'darken'
-    | 'lighten'
-    | 'color_dodge'
-    | 'color_burn'
-    | 'hard_light'
-    | 'soft_light'
-    | 'difference'
-    | 'exclusion'
-    | 'hue'
-    | 'saturation'
-    | 'color'
-    | 'luminosity';
-
-  type SpawnType = 'point' | 'rect' | 'circle' | 'ring' | 'burst';
-}

package/src/foundry/client/pixi/layers/effects/index.d.ts

@@ -1,4 +0,0 @@
-import './effect';
-import './leaves';
-import './rain';
-import './snow';

package/src/foundry/client/pixi/layers/effects/leaves.d.ts

@@ -1,79 +0,0 @@
-/**
- * A special full-screen weather effect which uses one Emitters to render gently falling autumn leaves
- */
-declare class AutumnLeavesWeatherEffect extends SpecialEffect {
-  /**
-   * @defaultValue `'Autumn Leaves'`
-   */
-  static get label(): string;
-
-  /**
-   * Configuration for the falling leaves particle effect
-   * @defaultValue
-   * ```typescript
-   * {
-   *   maxSpeed: 0,
-   *   noRotation: false,
-   *   blendMode: 'normal',
-   *   emitterLifetime: -1,
-   *   pos: {
-   *     x: 0,
-   *     y: 0
-   *   },
-   *   spawnType: 'rect',
-   *   alpha: {
-   *     start: 0.9,
-   *     end: 0.5
-   *   },
-   *   scale: {
-   *     start: 0.2,
-   *     end: 0.4,
-   *     minimumScaleMultiplier: 0.5
-   *   },
-   *   speed: {
-   *     start: 20,
-   *     end: 60,
-   *     minimumSpeedMultiplier: 0.6
-   *   },
-   *   startRotation: {
-   *     min: 0,
-   *     max: 365
-   *   },
-   *   rotation: 180,
-   *   rotationSpeed: {
-   *     min: 100,
-   *     max: 200
-   *   },
-   *   lifetime: {
-   *     min: 10,
-   *     max: 10
-   *   }
-   * }
-   * ```
-   */
-  static LEAF_CONFIG: PIXI.particles.EmitterConfig | PIXI.particles.OldEmitterConfig;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   density: {
-   *     label: "Particle Density",
-   *     type: this.OPTION_TYPES.RANGE,
-   *     value: 1,
-   *     min: 0.05,
-   *     max: 1,
-   *     step: 0.05
-   *   }
-   * }
-   * ```
-   */
-  static get effectOptions(): SpecialEffect.Options;
-
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  /**
-   * @internal
-   */
-  protected _getLeafEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-}

package/src/foundry/client/pixi/layers/effects/rain.d.ts

@@ -1,107 +0,0 @@
-/**
- * A special full-screen weather effect which uses two Emitters to render drops and splashes
- */
-declare class RainWeatherEffect extends SpecialEffect {
-  /**
-   * Configuration for the particle emitter for rain
-   * @defaultValue `'Rain'`
-   */
-  static get label(): string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   maxSpeed: 0,
-   *   noRotation: false,
-   *   blendMode: 'normal',
-   *   emitterLifetime: -1,
-   *   pos: {
-   *     x: 0,
-   *     y: 0
-   *   },
-   *   spawnType: 'rect',
-   *   alpha: {
-   *     start: 0.7,
-   *     end: 0.1
-   *   },
-   *   scale: {
-   *     start: 1.0,
-   *     end: 1.0,
-   *     minimumScaleMultiplier: 0.8
-   *   },
-   *   speed: {
-   *     start: 3500,
-   *     end: 3500,
-   *     minimumSpeedMultiplier: 0.8
-   *   },
-   *   startRotation: {
-   *     min: 75,
-   *     max: 75
-   *   },
-   *   rotation: 90,
-   *   rotationSpeed: {
-   *     min: 0,
-   *     max: 0
-   *   },
-   *   lifetime: {
-   *     min: 0.5,
-   *     max: 0.5
-   *   }
-   * }
-   * ```
-   */
-  static RAIN_CONFIG: PIXI.particles.EmitterConfig | PIXI.particles.OldEmitterConfig;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   maxSpeed: 0,
-   *   noRotation: false,
-   *   blendMode: 'normal',
-   *   emitterLifetime: -1,
-   *   pos: {
-   *     x: 0,
-   *     y: 0
-   *   },
-   *   spawnType: 'rect',
-   *   alpha: {
-   *     start: 1,
-   *     end: 1
-   *   },
-   *   scale: {
-   *     start: 0.6,
-   *     end: 0.6,
-   *     minimumScaleMultiplier: 0.8
-   *   },
-   *   speed: {
-   *     start: 0,
-   *     end: 0
-   *   },
-   *   startRotation: {
-   *     min: -90,
-   *     max: -90
-   *   },
-   *   noRotation: true,
-   *   lifetime: {
-   *     min: 0.5,
-   *     max: 0.5
-   *   }
-   * }
-   * ```
-   */
-  static SPLASH_CONFIG: PIXI.particles.EmitterConfig | PIXI.particles.OldEmitterConfig;
-
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  /**
-   * @internal
-   */
-  protected _getRainEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-
-  /**
-   * @internal
-   */
-  protected _getSplashEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-}

package/src/foundry/client/pixi/layers/effects/snow.d.ts

@@ -1,62 +0,0 @@
-/**
- * A special full-screen weather effect which uses one Emitters to render snowflakes
- */
-declare class SnowWeatherEffect extends SpecialEffect {
-  /**
-   * @defaultValue `'Snow'`
-   */
-  static get label(): string;
-
-  /**
-   * Configuration of the particle emitter for snowflakes
-   * @defaultValue
-   * ```typescript
-   * {
-   *   maxSpeed: 0,
-   *   noRotation: false,
-   *   blendMode: 'normal',
-   *   emitterLifetime: -1,
-   *   pos: {
-   *     x: 0,
-   *     y: 0
-   *   },
-   *   spawnType: 'rect',
-   *   alpha: {
-   *     start: 0.9,
-   *     end: 0.5
-   *   },
-   *   scale: {
-   *     start: 0.2,
-   *     end: 0.4,
-   *     minimumScaleMultiplier: 0.5
-   *   },
-   *   speed: {
-   *     start: 190,
-   *     end: 210,
-   *     minimumSpeedMultiplier: 0.6
-   *   },
-   *   startRotation: {
-   *     min: 50,
-   *     max: 75
-   *   },
-   *   rotation: 90,
-   *   rotationSpeed: {
-   *     min: 0,
-   *     max: 200
-   *   },
-   *   lifetime: {
-   *     min: 4,
-   *     max: 4
-   *   }
-   * }
-   * ```
-   */
-  static SNOW_CONFIG: PIXI.particles.EmitterConfig | PIXI.particles.OldEmitterConfig;
-
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  /**
-   * @internal
-   */
-  protected _getSnowEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-}

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

@@ -1,61 +0,0 @@
-/**
- * A CanvasLayer for displaying visual effects like weather, transitions, flashes, or more
- */
-declare class WeatherLayer extends CanvasLayer<WeatherLayer.LayerOptions> {
-  /**
-   * The weather overlay container
-   * @defaultValue `undefined`
-   */
-  weather: PIXI.Container | undefined;
-
-  /**
-   * The currently active weather effect
-   * @defaultValue `undefined`
-   */
-  weatherEffect: SpecialEffect | undefined;
-
-  /**
-   * Track the set of particle Emitter instances which are active within this Scene.
-   * @defaultValue `[]`
-   */
-  emitters: PIXI.particles.Emitter[];
-
-  /**
-   * An occlusion filter that prevents weather from being displayed in certain regions
-   * @defaultValue `undefined`
-   */
-  weatherOcclusionFilter: AbstractBaseMaskFilter | undefined;
-
-  /**
-   * @remarks This is not overridden in foundry but reflects the real behavior.
-   */
-  static get instance(): Canvas['weather'];
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.layerOptions, {
-   *   name: "effects",
-   *   zIndex: 700
-   * })
-   * ```
-   */
-  static get layerOptions(): WeatherLayer.LayerOptions;
-
-  override tearDown(): Promise<this>;
-
-  override draw(): Promise<undefined>;
-
-  /**
-   * Draw the weather container.
-   * @returns The weather container, or null if no effect is present
-   */
-  drawWeather(): Exclude<this['weather'], undefined> | null;
-}
-
-declare namespace WeatherLayer {
-  interface LayerOptions extends CanvasLayer.LayerOptions {
-    name: 'effects';
-    zIndex: 700;
-  }
-}