Struct entity_component::Components [−][src]
Holds components of a given type indexed by Entity
.
We do not check if the given entity is alive here, this should be done using
Entities
.
Implementations
impl<T> Components<T>
[src]
pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>
[src]
Inserts a component for the given Entity
index.
Returns the previous component, if any.
pub fn get(&self, entity: Entity) -> Option<&T>
[src]
Gets an immutable reference to the component of Entity
.
pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>
[src]
Gets a mutable reference to the component of Entity
.
pub fn remove(&mut self, entity: Entity) -> Option<T>
[src]
Removes the component of Entity
.
Returns Some(T)
if the entity did have the component.
Returns None
if the entity did not have the component.
pub fn iter<'a>(&'a self) -> impl Iterator<Item = &'a T>
[src]
Iterates immutably over all components of this type. Very fast but doesn’t allow joining with other component types.
pub fn iter_mut<'a>(&'a mut self) -> impl Iterator<Item = &'a mut T>
[src]
Iterates mutably over all components of this type. Very fast but doesn’t allow joining with other component types.
pub fn iter_with_bitset<'a>(
&'a self,
bitset: Rc<BitSetVec>
) -> ComponentIterator<'a, T>ⓘNotable traits for ComponentIterator<'a, T>
impl<'a, T> Iterator for ComponentIterator<'a, T> type Item = Option<&'a T>;
[src]
&'a self,
bitset: Rc<BitSetVec>
) -> ComponentIterator<'a, T>ⓘ
Notable traits for ComponentIterator<'a, T>
impl<'a, T> Iterator for ComponentIterator<'a, T> type Item = Option<&'a T>;
Iterates immutably over the components of this type where bitset
indicates the indices of entities.
Slower than iter()
but allows joining between multiple component types.
pub fn iter_mut_with_bitset<'a>(
&'a mut self,
bitset: Rc<BitSetVec>
) -> ComponentIteratorMut<'a, T>ⓘNotable traits for ComponentIteratorMut<'a, T>
impl<'a, T> Iterator for ComponentIteratorMut<'a, T> type Item = Option<&'a mut T>;
[src]
&'a mut self,
bitset: Rc<BitSetVec>
) -> ComponentIteratorMut<'a, T>ⓘ
Notable traits for ComponentIteratorMut<'a, T>
impl<'a, T> Iterator for ComponentIteratorMut<'a, T> type Item = Option<&'a mut T>;
Iterates mutable over the components of this type where bitset
indicates the indices of entities.
Slower than iter()
but allows joining between multiple component types.
pub fn bitset(&self) -> &BitSetVec
[src]
Returns the bitset indicating which entity indices have a component
associated to them.
Useful to build conditions between multiple Components
’ bitsets.
For example, take two bitsets from two different Components
types.
Then, bitset1.clone().bit_and(bitset2);
And finally, you can use bitset1 in iter_with_bitset
and iter_mut_with_bitset
.
This will iterate over the components of the entity only for entities that have both
components.
Trait Implementations
impl<T: 'static> Default for Components<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Components<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Components<T> where
T: Send,
T: Send,
impl<T> Sync for Components<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Components<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Components<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,