@league-of-foundry-developers/foundry-vtt-types 0.8.9-3 → 0.8.9-4

package/src/foundry/foundry.js/specialEffects/rainWeatherEffect.d.ts

@@ -2,14 +2,12 @@
  * 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;
 
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  _getRainEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-
-  _getSplashEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-
   /**
    * @defaultValue
    * ```typescript
@@ -94,4 +92,16 @@ declare class RainWeatherEffect extends SpecialEffect {
    * ```
    */
   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/foundry.js/specialEffects/snowWeatherEffect.d.ts

@@ -2,13 +2,13 @@
  * A special full-screen weather effect which uses one Emitters to render snowflakes
  */
 declare class SnowWeatherEffect extends SpecialEffect {
+  /**
+   * @defaultValue `'Snow'`
+   */
   static get label(): string;
 
-  getParticleEmitters(): PIXI.particles.Emitter[];
-
-  _getSnowEmitter(parent: PIXI.Container): PIXI.particles.Emitter;
-
   /**
+   * Configuration of the particle emitter for snowflakes
    * @defaultValue
    * ```typescript
    * {
@@ -52,4 +52,11 @@ declare class SnowWeatherEffect extends SpecialEffect {
    * ```
    */
   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/foundry.js/videoHelper.d.ts

@@ -6,15 +6,15 @@ declare class VideoHelper {
   constructor();
 
   /**
-   * A collectinon of HTML5 video objects which are currently active within the FVTT page
+   * A collection of HTML5 video objects which are currently active within the FVTT page
    * @defaultValue `[]`
+   * @remarks This seems to be unused.
    */
   videos: HTMLVideoElement[];
 
   /**
    * A user gesture must be registered before video playback can begin.
    * This Set records the video elements which await such a gesture.
-   * @defaultValue an empty Set
    */
   pending: Set<HTMLVideoElement>;
 
@@ -30,22 +30,20 @@ declare class VideoHelper {
    */
   locked: boolean;
 
-  /* -------------------------------------------- */
-  /*  Methods                                     */
-  /* -------------------------------------------- */
-
   static hasVideoExtension(src: string): boolean;
 
-  /* -------------------------------------------- */
-
   /**
    * Play a single video source
    * If playback is not yet enabled, add the video to the pending queue
    * @param video - The VIDEO element to play
    */
-  play(video: HTMLElement): void;
+  play(video: HTMLVideoElement): void;
 
-  /* -------------------------------------------- */
+  /**
+   * Stop a single video source
+   * @param video - The VIDEO element to stop
+   */
+  stop(video: HTMLVideoElement): void;
 
   /**
    * Register an event listener to await the first mousemove gesture and begin playback once observed
@@ -54,17 +52,14 @@ declare class VideoHelper {
    */
   awaitFirstGesture(): void;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle the first observed user gesture
    * We need a slight delay because unfortunately Chrome is stupid and doesn't always acknowledge the gesture fast enough.
    * @param event - The mouse-move event which enables playback
+   * @internal
    */
   protected _onFirstGesture(event: Event): void;
 
-  /* -------------------------------------------- */
-
   /**
    * Create and cache a static thumbnail to use for the video.
    * The thumbnail is cached using the video file path or URL.

package/src/foundry/index.d.ts

@@ -38,6 +38,7 @@ import './foundry.js/ray';
 import './foundry.js/roll';
 import './foundry.js/searchFilter';
 import './foundry.js/specialEffect';
+import './foundry.js/specialEffects';
 import './foundry.js/socketInterface';
 import './foundry.js/sortingHelpers';
 import './foundry.js/sound';
@@ -77,6 +78,7 @@ import './foundry.js/clientDocuments/playlist';
 import './foundry.js/clientDocuments/rollTable';
 import './foundry.js/clientDocuments/scene';
 import './foundry.js/clientDocuments/setting';
+import './foundry.js/clientDocuments/tableResult';
 import './foundry.js/clientDocuments/user';
 
 import './foundry.js/collections';
@@ -96,7 +98,3 @@ import './foundry.js/rollTerms/diceTerms/die';
 import './foundry.js/rollTerms/diceTerms/fateDie';
 
 import './foundry.js/pixi';
-
-import './foundry.js/specialEffects/autumnLeavesWeatherEffect';
-import './foundry.js/specialEffects/rainWeatherEffect';
-import './foundry.js/specialEffects/snowWeatherEffect';