Struct SingleMutEntity

pub struct SingleMutEntity<'a> { /* private fields */ }

This struct is very similar to the EntitiesAndComponents struct but it only allows access to components on a single entity for safety reasons

Implementations

impl<'a> SingleMutEntity<'a>

pub fn get_component<T: Component + Send + Sync>(&self) -> &T

Gets a reference to a component on an entity

pub fn get_resource<T: Resource + Send + Sync>(&self) -> &T

Gets a reference to a resource

pub fn try_get_component<T: Component + Send + Sync>(&self) -> Option<&Box<T>>

Gets a mutable reference to a component on an entity

pub fn get_component_mut<T: Component + Send + Sync>(&mut self) -> &mut T

Gets a tuple of references to components on an entity

pub fn try_get_component_mut<T: Component + Send + Sync>( &mut self, ) -> Option<&mut Box<T>>

Gets a mutable reference to a component on an entity

pub fn get_components<'b, T: ComponentsRef<'b> + Send + Sync + 'static>( &'b self, ) -> T::Result

Gets a tuple of references to components on an entity

pub fn try_get_components<'b, T: TryComponentsRef<'b> + Send + Sync + 'static>( &'b self, ) -> T::Result

Gets a tuple of references to components on an entity If the component does not exist on the entity it will return None

pub fn get_components_mut<'b, T: ComponentsMut<'b> + Send + Sync + 'static>( &'b mut self, ) -> T::Result

Gets a mutable reference to a component on an entity If the component does not exist on the entity, it will panic

pub fn try_get_components_mut<'b, T: TryComponentsMut<'b> + Send + Sync + 'static>( &'b mut self, ) -> T::Result

Gets a mutable reference to a component on an entity If the component does not exist on the entity it will return None

pub fn remove_component<T: Component + Send + Sync>(&mut self)

Removes a component from an entity If the component does not exist on the entity, it will do nothing

pub fn add_component<T: Component + Send + Sync>(&mut self, component: T)

Adds a component to an entity If the component already exists on the entity, it will be overwritten

pub fn has_component<T: Component + Send + Sync>(&self) -> bool

Checks if an entity has a certain component Returns true if the entity has the component, false otherwise

pub fn remove_entity(&mut self)

Removes the entity from the game engine If you call this function, the struct will be useless and will panic if you try to use it

pub fn get_entity(&self) -> Entity

Gets the entity that this struct is referencing useful for relating data in prestep and single_entity_step functions