pixi-reels

SkipOptions

pixi-reels


pixi-reels / index / SkipOptions

Interface: SkipOptions

Defined in: config/types.ts:101

Options for requestSkip() / skipSpin(), and for board.skip().

Properties#

PropertyTypeDescriptionDefined in
mode?SkipModeSee SkipMode. Defaults to the builder’s skipMode(), 'slam' unless set.config/types.ts:103
payload?unknownAnything the game wants a phase to see in onSkip(ctx), and any listener to see on skip:requested / skip:completed and SpinResult.skipContext: which button, which player, a reason. Passed through untouched.config/types.ts:116
speed?stringRegistered speed profile the freed reels finish on under 'quicken': its spinSpeed is the spin-out, its bounceDistance / bounceDuration the landing. Omit to keep the profile the spin started on. The common tuning is a pressed reel that lands on the turbo bounce. Ignored by a slam.config/types.ts:110