pixi-reels

ReelBounce

pixi-reels


pixi-reels / index / ReelBounce

Interface: ReelBounce

Defined in: spin/phases/ReelPhase.ts:55

A landing bounce in flight, returned by ReelPhase.bounce.

Extends#

Properties#

PropertyModifierTypeDescriptionOverridesDefined in
donereadonlyPromise<void>Settles once the reel is back on its resting position, or right after cancel(). Never rejects, so a phase can await it without a guard.Cancellable.donespin/phases/ReelPhase.ts:60

Methods#

cancel()#

cancel(): void;

Defined in: spin/phases/ReelPhase.ts:66

Kill the tween and rest the reel where the bounce began. What a phase does from onSkip() when a slam lands mid-bounce. Idempotent, and a no-op once the bounce has settled.

Returns#

void

Overrides#

Cancellable.cancel