SpineReelSymbolOptions
pixi-reels / spine / SpineReelSymbolOptions
Interface: SpineReelSymbolOptions
Defined in: spine/SpineReelSymbol.ts:28
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
animations? | SymbolAnimOverrides | Per-symbol overrides (see SymbolAnimOverrides). | spine/SpineReelSymbol.ts:46 |
autoPlayBlur? | boolean | If true, automatically plays the blur animation when the owning reel enters the spin phase, and reverts to idle when it lands. Requires the skeleton to have a blur animation (or the overridden name). Default: false. | spine/SpineReelSymbol.ts:54 |
autoPlayLanding? | | boolean | ((ctx: ReelLandingContext) => LandingDecision) | What plays when the owning reel lands, concurrently with the stop-phase bounce. Default: false (nothing). - true: the landing animation (or the overridden name), then idle. - false: nothing. - a function: asked per landing with the ReelLandingContext - which reel and cell this symbol landed in - and returns one of the above, or an animation NAME to play as the landing beat on this reel and cell instead. So a symbol can land on reels 1-3, skip its landing on the reel a takeover is about to run on, and play a different beat on the last one. Requires the skeleton to have the animation; a missing one is skipped. | spine/SpineReelSymbol.ts:70 |
blurAnimation? | string | Default “blur” (fast spin) animation name. Default: ‘blur’. | spine/SpineReelSymbol.ts:44 |
idleAnimation? | string | Default idle animation name. Default: ‘idle’. | spine/SpineReelSymbol.ts:32 |
landingAnimation? | string | Default landing (one-shot) animation name. Default: ‘landing’. | spine/SpineReelSymbol.ts:36 |
outAnimation? | string | Default “exit” animation name. used as the cascade pop / disintegrate. If the skeleton doesn’t have it, callers should fall back to an alpha tween. Default: ‘disintegration’. | spine/SpineReelSymbol.ts:42 |
scale? | number | Scale for spine instances. Default: 1. | spine/SpineReelSymbol.ts:48 |
spineMap | Record<string, SpineSymbolSource> | Map of symbolId -> spine source. | spine/SpineReelSymbol.ts:30 |
winAnimation? | string | Default win animation name. Default: ‘win’. | spine/SpineReelSymbol.ts:34 |