pixi-reels

ScatterAnticipationOptions

pixi-reels


pixi-reels / index / ScatterAnticipationOptions

Interface: ScatterAnticipationOptions

Defined in: spin/anticipationRecipes.ts:3

Properties

PropertyTypeDescriptionDefined in
mode?"all-remaining" | "scatter-only"Which of the remaining reels should tease: - 'all-remaining' (default): every reel after the trigger reel teases, whether or not it actually holds the symbol. Maximum tension. - 'scatter-only': only reels that actually contain the symbol tease. Use when a result can’t complete the feature on some reels and you don’t want to fake tension on reels that don’t matter (e.g. a grid with only 3 scatters total shouldn’t slow the empty reels between/after them).spin/anticipationRecipes.ts:23
symbolstringThe trigger symbol id to scan for (e.g. 'SCAT').spin/anticipationRecipes.ts:5
trigger?numberHow many of symbol must be showing before anticipation kicks in. Anticipation begins on the reel AFTER the one that lands the trigger-th symbol. Default 2 (the classic “2 scatters and the rest of the reels start teasing”).spin/anticipationRecipes.ts:12