Win
pixi-reels / index / Win
Interface: Win
Defined in: config/types.ts:299
One “win” as the presenter sees it: an ordered set of cells to highlight.
Use cases collapse onto this one shape. whether those cells came from a classic payline (“row 1 across all 5 reels”), a cascade pop (“this cluster vanished”), a scatter splash, or a bonus reveal.
The presenter’s job is to animate these cells. Anything beyond that.
drawing a polyline, a cluster outline, a number popup, a sound cue. is
user-land code reacting to the win:* events. pixi-reels never draws wins.
Order of cells matters when WinPresenter.stagger > 0 (e.g. a
left-to-right sweep): cell N starts animating stagger ms after cell N-1.
Pass the cells in the order you want the sweep to run.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
cells | readonly SymbolPosition[] | Cells to highlight. Order matters when stagger > 0. | config/types.ts:301 |
id? | number | Optional stable id so event consumers can key per-win state. | config/types.ts:307 |
kind? | string | Optional tag for routing events to different handlers. | config/types.ts:305 |
value? | number | Optional payout. used for the default value-desc sort. | config/types.ts:303 |