Skip to main content

EnterMapSpinState

Struct EnterMapSpinState 

Source
pub struct EnterMapSpinState { /* private fields */ }
Expand description

State of the arrival spin animation.

Frame-driven: constructed when a teleport-class warp is committed; ticked once per frame once the fade-in from white has completed (the player stays hidden during the fade). spin_in_place mirrors the standing-on-warp-pad check: arrivals on a warp pad/hole skip the final spin-in-place.

Implementations§

Source§

impl EnterMapSpinState

Source

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

Source

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

Advance one frame. Returns the sound cue to play this frame, if any (EnterMapSpinSfx::Descend at the start of the spin-down, EnterMapSpinSfx::Land when it completes).

Source

pub fn is_done(&self) -> bool

Source

pub fn phase(&self) -> EnterMapSpinPhase

Source

pub fn facing(&self) -> Direction

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

Source

pub fn player_y_offset(&self) -> i32

Vertical pixel offset of the player sprite (≤ 0; the player descends from off the top of the screen into the standing position).

Source

pub fn player_visible(&self) -> bool

Whether the player sprite is still off the top of the screen.

Trait Implementations§

Source§

impl Clone for EnterMapSpinState

Source§

fn clone(&self) -> EnterMapSpinState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EnterMapSpinState

Source§

impl Debug for EnterMapSpinState

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.