Struct gemini_engine::elements::ascii::AnimatedSprite

pub struct AnimatedSprite {
    pub pos: Vec2D,
    pub frames: Vec<String>,
    pub current_frame: usize,
    pub modifier: Modifier,
    pub align: TextAlign2D,
}

The AnimatedSprite struct contains a list of Strings into which it indexes based on its current_frame property. You can cycle through frames with the AnimatedSprite::next_frame() function

Fields

pos: Vec2D

The position from which the animated sprite will be drawn from

frames: Vec<String>

A collection of frames - ACII textures to be displayed by the AnimatedSprite

current_frame: usize

The current frame being displayed. This will index directly into frames

modifier: Modifier

A raw Modifier, determining the appearance of the AnimatedSprite

align: TextAlign2D

How the Sprite should align to the position

Implementations

impl AnimatedSprite

pub fn new(pos: Vec2D, frames: &[&str], modifier: Modifier) -> Self

Create a new AnimatedSprite struct. All newlines at the beginning of each texture will be removed

pub fn next_frame(&mut self)

Go to the next frame of the AnimatedSprite’s frames. Will automatically wrap around at the end of the list

pub fn is_within_frame_range(&self) -> bool

Returns true if the current_frame property is within range of the list of frames. Also returns false if the list of frames is empty

Trait Implementations

impl ViewElement for AnimatedSprite

fn active_pixels(&self) -> Vec<Pixel>

Return a vector of the element’s Pixels - A ColChar. If your whole object is a solid colour, consider using utils::points_to_pixels() which will add the same ColChar to every point and can then be used as this function’s output

fn active_points(&self) -> Vec<Vec2D>

Return the positions the ViewElement occupies, essentially active_pixels() without the ColChars. This has a default setting that extracts the Vec2Ds from active_pixels but you can set it to something else to make it faster