@energy8platform/game-engine 0.33.8 → 0.33.9

package/dist/slot.d.ts

@@ -918,6 +918,18 @@ interface CreateReelSystemOptions {
     /** Custom feature modules to register alongside the 13 built-ins. */
     features?: ReelFeature[];
 }
+/** Options for a stepped chain (`cascade` / `reelStep`). */
+interface StepRunOpts<TStep> {
+    turbo?: boolean;
+    /** Carry the running multiplier across free spins (with `cascade.multiplier.persistInFreeSpins`). */
+    freeSpins?: boolean;
+    /**
+     * Fires after each step has settled, with the step's index and the running multiplier AFTER it.
+     * The hook for a step-by-step payout readout: report the win accrued so far to the shell via
+     * `api.shell.reportWin(...)`. Awaited, so an async hook paces the chain.
+     */
+    onStep?: (index: number, step: TStep, multiplier: number) => void | Promise<void>;
+}
 interface ReelSystem {
     /** Root container — add this to your scene. */
     readonly view: Container;
@@ -935,20 +947,16 @@ interface ReelSystem {
     /** Replace the whole config. */
     setConfig(config: ReelSystemConfig): void;
     spin(target: CellData[][], opts?: SpinRunOpts): Promise<void>;
-    /** Run a cascade chain. With `freeSpins` + `cascade.multiplier.persistInFreeSpins`, the multiplier carries over instead of resetting. */
-    cascade(steps: TumbleStep[], opts?: {
-        turbo?: boolean;
-        freeSpins?: boolean;
-    }): Promise<void>;
+    /** Run a cascade chain. With `freeSpins` + `cascade.multiplier.persistInFreeSpins`, the multiplier
+     *  carries over instead of resetting. Generic in the step type, so `onStep` hands back the game's
+     *  own step (with its per-step win) rather than the bare TumbleStep. */
+    cascade<TStep extends TumbleStep>(steps: TStep[], opts?: StepRunOpts<TStep>): Promise<void>;
     /**
      * Run a ReelStep™ chain: each step pays its winning cells, then scrolls every reel down by
      * `shifts[col]` positions (0 = reel stays put). Multiplier carries over with `freeSpins` +
      * `cascade.multiplier.persistInFreeSpins`, same as `cascade`.
      */
-    reelStep(steps: ReelStepData[], opts?: {
-        turbo?: boolean;
-        freeSpins?: boolean;
-    }): Promise<void>;
+    reelStep<TStep extends ReelStepData>(steps: TStep[], opts?: StepRunOpts<TStep>): Promise<void>;
     /** Current running cascade / reel-step multiplier. */
     readonly multiplier: number;
     /** Register a custom feature (or override a built-in by reusing its key). */
@@ -1049,4 +1057,4 @@ declare class MultiplierAccumulator {
 }
 
 export { AnimatedSymbol, AnticipationController, BigWinOverlay, CascadeController, CountUpDisplay, DEFAULT_REEL_CONFIG, EASING_BY_NAME, FEATURES, FEATURE_KEYS, FEATURE_LIST, INTENSITY_SCALE, MultiplierAccumulator, PRESETS, PRESET_LIST, ReelGrid, ReelSpinController, ReelStepController, SpinEngine, SymbolCell, TumbleController, buildReelStepTape, cellPositionOf, createReelSystem, easingByName, effectiveRowsPerReel, mergeReelConfig, pickTier, resolveGeometry, resolveGridGeometry, resolveReelConfig, tierIndexAtValue, valueAt, waysCount };
-export type { AnimatedSymbolConfig, AnticipationConfig, AnticipationDecision, BigWinOverlayConfig, BlurConfig, CarryPolicy, CascadeAnim, CascadeConfig, CascadeStepData, CascadeTimings, CellData, CellFrameStyle, CellSizeSpec, CellState, CountUpConfig, CreateReelSystemOptions, DecorationConfig, DeepPartial, EasingName, EvaluationMode, ExpandingWildConfig, FeatureContext, FeatureKey, FeaturesConfig, GeometryInput, GiantConfig, GridConfig, HoldAndSpinConfig, Intensity, MotionConfig, MotionStyle, MultiplierConfig, MysteryConfig, NudgeConfig, PresetId, RandomWildConfig, ReelFeature, ReelGridConfig, ReelModifierConfig, ReelPreset, ReelSpinData, ReelSpinTimings, ReelStepData, ReelStopPlan$1 as ReelStopPlan, ReelSystem, ReelSystemConfig, ResolvedGeometry, SettleConfig, SpinData, SpinRunOpts, ReelStopPlan as SpinStopPlan, SplitConfig, SquashConfig, StackedConfig, StickyConfig, StopMode, StopOrder, SymbolCellConfig, SymbolResolver, SymbolTextures, SymbolView, TransformConfig, TumbleStep, WalkingWildConfig, WinConfig, WinTier };
+export type { AnimatedSymbolConfig, AnticipationConfig, AnticipationDecision, BigWinOverlayConfig, BlurConfig, CarryPolicy, CascadeAnim, CascadeConfig, CascadeStepData, CascadeTimings, CellData, CellFrameStyle, CellSizeSpec, CellState, CountUpConfig, CreateReelSystemOptions, DecorationConfig, DeepPartial, EasingName, EvaluationMode, ExpandingWildConfig, FeatureContext, FeatureKey, FeaturesConfig, GeometryInput, GiantConfig, GridConfig, HoldAndSpinConfig, Intensity, MotionConfig, MotionStyle, MultiplierConfig, MysteryConfig, NudgeConfig, PresetId, RandomWildConfig, ReelFeature, ReelGridConfig, ReelModifierConfig, ReelPreset, ReelSpinData, ReelSpinTimings, ReelStepData, ReelStopPlan$1 as ReelStopPlan, ReelSystem, ReelSystemConfig, ResolvedGeometry, SettleConfig, SpinData, SpinRunOpts, ReelStopPlan as SpinStopPlan, SplitConfig, SquashConfig, StackedConfig, StepRunOpts, StickyConfig, StopMode, StopOrder, SymbolCellConfig, SymbolResolver, SymbolTextures, SymbolView, TransformConfig, TumbleStep, WalkingWildConfig, WinConfig, WinTier };

package/dist/slot.esm.js

@@ -2943,6 +2943,7 @@ function createReelSystem(opts) {
             for (let i = 0; i < steps.length; i++) {
                 await tumble.step(steps[i], i, cOpts);
                 board = steps[i].settledGrid;
+                await cOpts?.onStep?.(i, steps[i], tumble.multiplier);
             }
             if (config.cascade.multiplier.enabled)
                 log?.(`Cascade multiplier ×${tumble.multiplier}`);
@@ -2954,6 +2955,7 @@ function createReelSystem(opts) {
             for (let i = 0; i < steps.length; i++) {
                 await reelStepCtl.step(steps[i], i, rOpts);
                 board = steps[i].settledGrid;
+                await rOpts?.onStep?.(i, steps[i], reelStepCtl.multiplier);
             }
             if (config.cascade.multiplier.enabled)
                 log?.(`ReelStep multiplier ×${reelStepCtl.multiplier}`);