Struct amethyst_utils::removal::Removal

pub struct Removal<I> where
    I: Debug + Clone + Send + Sync + 'static,  { /* fields omitted */ }

A marker Component used to remove entities and clean up your scene. The generic parameter I is the type of id you want to use. Generally an int or an enum.

Example

#[derive(Clone, Debug, PartialEq)]
enum RemovalId {
    Something,
    Something2,
}

let _entity1 = world.create_entity().with(Removal::new(RemovalId::Something)).build();
let _entity2 = world.create_entity().with(Removal::new(RemovalId::Something2)).build();

// Remove all entities with the RemovalId value of Something.
exec_removal(&world.entities(), &world.read_storage(), RemovalId::Something);

// Force the world to be up to date. This is normally called automatically at the end of the
// frame by amethyst.
world.maintain();

// Count entities remaining in the world.
assert_eq!((&*world.entities(),).join().count(), 1);

Methods

impl<I> Removal<I> where
    I: Debug + Clone + Send + Sync + 'static, 

pub fn new(id: I) -> Self

Creates a new Removal component with the specified id.

Trait Implementations

impl<I: Clone> Clone for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static, 

fn clone(&self) -> Removal<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static, 

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

Formats the value using the given formatter.

impl<I> Serialize for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static,
    I: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<'de, I> Deserialize<'de> for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static,
    I: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<'pfd, I> PrefabData<'pfd> for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static, 

type SystemData = WriteStorage<'pfd, Removal<I>>

SystemData needed to perform the load

type Result = ()

The result type returned by the load operation

fn add_to_entity(
    &self,
    entity: Entity,
    system_data: &mut Self::SystemData,
    _: &[Entity],
    _: &[Entity]
) -> 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.

impl<I> Component for Removal<I> where
    I: Debug + Clone + Send + Sync + 'static, 

type Storage = DenseVecStorage<Self>

Associated storage type for this component.