DestroySymbolsOptions
pixi-reels / index / DestroySymbolsOptions
Interface: DestroySymbolsOptions
Defined in: core/ReelSet.ts:56
Options for ReelSet.destroySymbols. Every field is optional; the defaults produce the canonical “winners poof” look (no stagger, no viewport dim, zIndex bumped to 1000 so destroy effects render above neighbouring cells).
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
delay? | | number | ((cell: Cell, index: number) => number) | Per-cell start delay in seconds. Default 0 (every cell starts together). Pass (cell, i) => i * 0.03 for a per-cell stagger. | core/ReelSet.ts:61 |
dim? | number | boolean | Dim the viewport (viewport.showDim(alpha)) while the destroy animation runs, restoring on completion. Pass false to skip, a number for a custom alpha. Default: false (no dim). | core/ReelSet.ts:75 |
signal? | AbortSignal | Abort signal. Aborting mid-destroy kills every in-flight playDestroy tween and snaps the cells to their destroyed pose (alpha: 0) without waiting for the natural end of the animation. The returned promise still resolves normally. abort means “fast-forward to the destroyed state,” not “fail.” Forwarded automatically by runCascade’s own signal. | core/ReelSet.ts:84 |
zIndex? | number | null | zIndex applied to each cell’s view for the duration of the animation so destroy effects aren’t clipped behind neighbours. Default 1000. The library does NOT restore the previous zIndex. the cell is destroyed (alpha 0) and will be replaced on the next refill() / setResult(). Pass null to skip the bump. | core/ReelSet.ts:69 |