SpeedProfile
pixi-reels / index / SpeedProfile
Interface: SpeedProfile
Defined in: config/types.ts:70
Timing and animation profile for a speed mode.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
accelerationDuration? | readonly | number | Milliseconds for acceleration phase. Default: 300. | config/types.ts:89 |
accelerationEase? | readonly | string | Optional GSAP ease string for acceleration. Default: ‘power2.in’. | config/types.ts:85 |
anticipationDelay | readonly | number | Milliseconds to hold anticipation phase. | config/types.ts:79 |
bounceDistance | readonly | number | Pixels of overshoot when reel lands. | config/types.ts:81 |
bounceDuration | readonly | number | Milliseconds for bounce-back animation. | config/types.ts:83 |
decelerationEase? | readonly | string | Optional GSAP ease string for deceleration. Default: ‘power2.out’. | config/types.ts:87 |
minimumSpinTime? | readonly | number | Minimum spin time in ms before stop is allowed. Default: 500. | config/types.ts:91 |
name | readonly | string | - | config/types.ts:71 |
spinDelay | readonly | number | Milliseconds between each reel starting to spin. | config/types.ts:73 |
spinSpeed | readonly | number | Pixels per frame at full spin speed. | config/types.ts:75 |
stopDelay | readonly | number | Milliseconds between each reel stopping. | config/types.ts:77 |
tumble? | readonly | TumbleConfig | Optional per-speed tumble timing overrides. When the active speed profile defines this, the cascade fall + drop-in phases merge these fields over the base config registered via .tumble(...) at build time. setSpeed('turbo') can shorten fall.duration, dropIn.duration, per-row staggers, and the drop ease without the caller maintaining a parallel setTumble API. Fields are deep-merged with Partial semantics: omitted fields fall back to the base config. To suppress the cascade animation entirely for a profile (the canonical “snap on turbo” pattern), set fall.duration: 0 and dropIn.duration: 0. both phases short-circuit to their existing snap path. Phases capture the resolved config at onEnter time, so a setSpeed call between two refills picks up the new timings on the next refill. In-flight tweens keep their construction-time timings (mid-tween mutation is not supported). | config/types.ts:111 |