Struct rusty_engine::sprite::Sprite

pub struct Sprite {
    pub label: String,
    pub filepath: PathBuf,
    pub collider_filepath: PathBuf,
    pub translation: Vec2,
    pub layer: f32,
    pub rotation: f32,
    pub scale: f32,
    pub collision: bool,
    pub collider: Collider,
    pub collider_dirty: bool,
}

A Sprite is the basic abstraction for something that can be seen and interacted with. Players, obstacles, etc. are all sprites.

Fields

label: String

READONLY: A way to identify a sprite. This must be unique, or else the game will crash.

filepath: PathBuf

READONLY: File used for this sprite’s image

collider_filepath: PathBuf

READONLY: File used for this sprite’s collider. Note that this file will not exist if the sprite does not have a collider, but if you set the collider field to a collider and then call the write_collider method, the file will be written for you!

translation: Vec2

SYNCED: Where you are in 2D game space. Positive x is right. Positive y is up. (0.0, 0.0) is the center of the screen.

layer: f32

SYNCED: Depth of the sprite. 0.0 (back) to 999.0 (front)

rotation: f32

SYNCED: Direction you face in radians. See constants UP, DOWN, LEFT, RIGHT

scale: f32

SYNCED: 1.0 is the normal 100%

collision: bool

Whether or not to calculate collisions

collider: Collider

The actual collider for this sprite

collider_dirty: bool

If set to true, then the collider shown for this sprite will be regenerated (see also Engine.show_colliders). Normally you shouldn’t touch this, but if you manually replace a Sprite’s Collider in a game logic function, then you need to set this to true.

Implementations

impl Sprite

pub fn new<S: Into<String>, P: Into<PathBuf>>( label: S, file_or_preset: P ) -> Self

label should be a unique string (it will be used as a key in the hashmap Engine::sprites). file_or_preset should either be a SpritePreset variant, or a relative path to an image file inside the assets/ directory. If a collider definition exists in a file with the same name as the image file, but with the .collider extension, then the collider will be loaded automatically. To create a collider file you can either run the collider example, or programmatically create a Collider, set the sprite’s .collider field to it, and call the sprite’s .write_collider() method. All presets have collider files already.

pub fn write_collider(&self) -> bool

Attempt to take the current collider and write it to collider_filepath. If there isn’t a collider, or writing fails, then false is returned. Otherwise true is returned.

pub fn add_collider_point(&mut self, p: Vec2)

Add a collider point. p is a Vec2 in worldspace (usually the mouse coordinate). See the collider example.

pub fn change_last_collider_point(&mut self, p: Vec2)

Change the last collider point. p is a Vec2 in worldspace (usually the mouse coordinate). See the collider example.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Sprite

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl PartialEq for Sprite

fn eq(&self, other: &Sprite) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Sprite