Skip to main content

ElevatorShakeState

Struct ElevatorShakeState 

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

Frame-driven elevator rumble: scrolls the background up/down by ±pixel_offset, iterations × 2 frames, a rattle cue each iteration, then a single arrival ding.

Implementations§

Source§

impl ElevatorShakeState

Source

pub fn new(params: ElevatorShakeParams) -> Self

Source

pub fn params(&self) -> ElevatorShakeParams

Source

pub fn total_frames(&self) -> u16

Total frames of the shake.

Source

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

Advance one frame. Returns ElevatorShakeSfx::Rattle at the start of each 2-frame iteration and ElevatorShakeSfx::Arrive on the final frame.

Source

pub fn is_done(&self) -> bool

Source

pub fn offset_y(&self) -> i32

Current background scroll offset (±pixel_offset). The first iteration scrolls negative.

Trait Implementations§

Source§

impl Clone for ElevatorShakeState

Source§

fn clone(&self) -> ElevatorShakeState

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 ElevatorShakeState

Source§

impl Debug for ElevatorShakeState

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, <T as TryFrom<U>>::Error>

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.