flocc 0.5.21 → 0.5.23

package/dist/environments/Environment.d.ts

@@ -53,6 +53,15 @@ declare class Environment extends Agent {
     opts: EnvironmentOptions;
     width: number;
     height: number;
+    /**
+     * Whether the `Environment` tick cycle is currently playing.
+     * Use {@linkcode pause}, {@linkcode resume}, or {@linkcode toggle}
+     * to control playback.
+     * @since 0.5.22
+     */
+    playing: boolean;
+    /** @hidden */
+    private _tickIntervalId;
     /**
      * This property will always equal the number of tick cycles that
      * have passed since the `Environment` was created. If you call
@@ -179,6 +188,35 @@ declare class Environment extends Agent {
      * @since 0.0.5
      */
     tick(opts?: number | TickOptions): void;
+    /**
+     * Pause the tick cycle. While paused, calling {@linkcode tick} will
+     * be a no-op unless you use {@linkcode step} to advance manually.
+     * @since 0.5.22
+     */
+    pause(): void;
+    /**
+     * Resume the tick cycle after it has been paused.
+     * @since 0.5.22
+     */
+    resume(): void;
+    /**
+     * Toggle the tick cycle between playing and paused.
+     * @since 0.5.22
+     */
+    toggle(): void;
+    /**
+     * Advance the `Environment` by exactly one tick, regardless of whether
+     * it is paused. This is useful for stepping through the simulation
+     * frame-by-frame while paused.
+     *
+     * ```js
+     * environment.pause();
+     * environment.step(); // advances one tick
+     * ```
+     *
+     * @since 0.5.22
+     */
+    step(opts?: number | TickOptions): void;
     /**
      * Use a helper with this environment. A helper can be one of:
      * - {@linkcode KDTree}