Struct TeleportSpinState 

pub struct TeleportSpinState { /* private fields */ }

State of the teleport / escape-item spin-out animation.

Frame-driven: constructed when the leave-warp is triggered, ticked once per frame by the update loop; the warp fade-out starts when Self::is_done becomes true.

spin_order is the facing cycle the animation rotates through, starting from the player’s current facing (the classic order is [Down, Left, Up, Right]).

Implementations

impl TeleportSpinState

pub fn new(current_facing: Direction, spin_order: [Direction; 4]) -> Self

pub fn tick(&mut self) -> Option<TeleportSpinSfx>

Advance one frame. Returns the sound cue to play this frame, if any (TeleportSpinSfx::SpinLoop on spins whose delay is a multiple of 4, TeleportSpinSfx::Rise at the start of the spin-up).

pub fn is_done(&self) -> bool

pub fn phase(&self) -> TeleportSpinPhase

pub fn facing(&self) -> Direction

Current player facing (the spin rotating through the facing cycle).

pub fn player_y_offset(&self) -> i32

Vertical pixel offset of the player sprite (≤ 0; rises off screen during the spin-up phase).

pub fn player_visible(&self) -> bool

Whether the player sprite is still on screen (by the last step the sprite has risen fully above the visible area).

Trait Implementations

impl Clone for TeleportSpinState

fn clone(&self) -> TeleportSpinState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TeleportSpinState

impl Debug for TeleportSpinState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TeleportSpinState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TeleportSpinState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.