Skip to main content

TileAnimState

Struct TileAnimState 

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

Per-frame water/flower background-tile animation.

  • counter1 increments every frame; at 20 the water tile rotates one pixel; at 21 (TileAnimKind::WaterFlower only) the flower tile advances and counter1 resets. For water-only tilesets counter1 resets right after the water update.
  • counter2 increments on each water update (& 7); its bit 2 selects the water rotation direction (right for 4 updates, then left for 4), and counter2 & 3 selects the flower frame (0/1 → 1, 2 → 2, 3 → 3).

Implementations§

Source§

impl TileAnimState

Source

pub fn new() -> Self

Source

pub fn set_tileset(&mut self, kind: TileAnimKind)

Adopt a tileset’s animation kind and reset counter1 (counter2 and the accumulated water shift persist, matching the classic WRAM behavior on map load).

Source

pub fn tick(&mut self)

Advance one frame. No-op when the tileset has no animated tiles.

Source

pub fn water_shift(&self) -> i8

Current horizontal rotation of the water tile in pixels (positive = right). Sample source column (x - shift) mod 8.

Source

pub fn flower_frame(&self) -> Option<u8>

Flower frame (1..=3) to display, or None before the first flower update (the tileset’s base flower tile shows).

Source

pub fn kind(&self) -> TileAnimKind

Animation kind for the current tileset.

Trait Implementations§

Source§

impl Clone for TileAnimState

Source§

fn clone(&self) -> TileAnimState

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 TileAnimState

Source§

impl Debug for TileAnimState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TileAnimState

Source§

fn default() -> Self

Returns the “default value” for a type. 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.