PR pixi-reels

WinSymbolAnim

pixi-reels


pixi-reels / index / WinSymbolAnim

Type Alias: WinSymbolAnim

type WinSymbolAnim = 
  | "win"
  | string
  | ((symbol: ReelSymbol, cell: SymbolPosition, win: Win) => Promise<void>);

Defined in: wins/WinPresenter.ts:18

What to play on each cell being highlighted.

  • 'win'. default. Calls symbol.playWin() (your subclass’s hook).
  • string. a named animation. If the symbol exposes a playAnimation(name) method (e.g. SpineSymbol), it’s invoked; else it falls back to playWin().
  • (symbol, cell, win) => Promise<void>. drive the animation yourself. Good for GSAP bounces, line-specific pulses, etc.