Enum amethyst_rendy::sprite::prefab::SpriteSheetPrefab

pub enum SpriteSheetPrefab {
    Handle((Option<String>, Handle<SpriteSheet>)),
    Sheet {
        texture: TexturePrefab,
        sprites: Vec<Sprites>,
        name: Option<String>,
    },
}

Defines a spritesheet prefab. Note that this prefab will only load the spritesheet in storage, no components will be added to entities. The add_to_entity will return the Handle<SpriteSheet>. For this reason it is recommended that this prefab is only used as part of other PrefabData or in specialised formats. See SpriteScenePrefab for an example of this.

Variants

Handle((Option<String>, Handle<SpriteSheet>))

Spritesheet handle, normally not used outside the prefab system.

Sheet

Definition of a spritesheet

Fields of Sheet

texture: TexturePrefab

This texture contains the images for the spritesheet

sprites: Vec<Sprites>

The sprites in the spritesheet

name: Option<String>

The name of the spritesheet to refer to it

Trait Implementations

impl Clone for SpriteSheetPrefab

fn clone(&self) -> SpriteSheetPrefab

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSheetPrefab

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

Formats the value using the given formatter.

impl Serialize for SpriteSheetPrefab

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SpriteSheetPrefab

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> PrefabData<'a> for SpriteSheetPrefab

type SystemData = (<TexturePrefab as PrefabData<'a>>::SystemData, Read<'a, SpriteSheetLoadedSet>, Read<'a, AssetStorage<SpriteSheet>>, ReadExpect<'a, Loader>)

SystemData needed to perform the load

type Result = (Option<String>, Handle<SpriteSheet>)

The result type returned by the load operation

fn add_to_entity(
    &self,
    _entity: Entity,
    _system_data: &mut Self::SystemData,
    _entities: &[Entity],
    _children: &[Entity]
) -> Result<Self::Result, Error>

Add the data for this prefab onto the given Entity

fn load_sub_assets(
    &mut self,
    progress: &mut ProgressCounter,
    system_data: &mut Self::SystemData
) -> Result<bool, Error>

Trigger asset loading for any sub assets.