PR pixi-reels

MovePinOptions

pixi-reels


pixi-reels / index / MovePinOptions

Interface: MovePinOptions

Defined in: pins/CellPin.ts:122

Options for reelSet.movePin(). flight animation tuning + lifecycle hooks.

Properties

PropertyTypeDescriptionDefined in
backfill?stringSymbol id to use as the filler at the vacated cell. When omitted, the engine picks a random symbol from its frame builder’s random provider.pins/CellPin.ts:131
duration?numberAnimation duration in milliseconds. Default 400.pins/CellPin.ts:124
easing?stringGSAP easing string. Default ‘power2.inOut’.pins/CellPin.ts:126
onFlightCompleted?(flight: unknown) => voidFires after the tween completes, before the flight symbol is released back to the pool. Use this hook to play a landing animation or return a Spine symbol to idle before its instance is recycled.pins/CellPin.ts:148
onFlightCreated?(flight: unknown) => voidFires after the flight symbol is acquired, positioned at from, and added to the viewport. but before the tween begins. Use this hook to drive animation state on the flight instance. For example: cast to your SpineSymbol subclass and switch to a run animation for the duration of the flight. flight is the pooled ReelSymbol instance. The type is unknown so this module stays free of circular imports; cast in the caller.pins/CellPin.ts:142