Struct Sprite 

pub struct Sprite {

    pub name: String,
    pub variables: HashMap<String, Variable>,
    pub lists: HashMap<String, List>,
    pub scripts: Vec<Script>,
    pub current_costume: usize,
    pub sounds: HashMap<String, Sound>,
    pub volume: f32,
    pub layer_order: isize,
    pub visible: bool,
    pub position: (i32, i32),
    pub size: f32,
    pub direction: i32,
    pub draggable: bool,
    pub rotation_style: RotationStyle,
    /* private fields */
}

The Sprite struct represents a sprite in a Scratch 3.0 project.

Fields

name: String

The name of the sprite.

variables: HashMap<String, Variable>

Contains all the variables of the sprite.

lists: HashMap<String, List>

Contains all the lists of the sprite.

scripts: Vec<Script>

Contains all the scripts of the sprite.

current_costume: usize

The index of the current costume.

sounds: HashMap<String, Sound>

Contains all the sounds of the sprite.

volume: f32

The sprite’s volume (0.0 = 0%, 1.0 = 100%)

layer_order: isize

The layer of the sprite.

visible: bool

If the sprite is visible.

position: (i32, i32)

The position of the sprite.

size: f32

The size of the sprite (0.0 = 0%, 1.0 = 100%)

direction: i32

The direction of the sprite in degrees.

draggable: bool

If the sprite is draggable.

rotation_style: RotationStyle

The rotation style of the sprite.

Implementations

impl Sprite

pub fn new( raw: RawSprite, zip: &mut ZipArchive<Cursor<Vec<u8>>>, ) -> Result<Self, DecodeError>

Returns a new sprite from a RawSprite and the zip archive.

pub fn get_costume(&self, name: &str) -> Option<&Costume>

Returns a reference to a costume by its name, if it exists.

pub fn get_costume_mut(&mut self, name: &str) -> Option<&mut Costume>

Returns a mutable reference to a costume by its name, if it exists.

pub fn costume_names(&self) -> Vec<&String>

Returns all the costume names in the sprite.

pub fn costumes(&self) -> Vec<&Costume>

Returns all the costumes in the sprite.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.