Struct AtomicComponentStoreRefMut 

pub struct AtomicComponentStoreRefMut<'a, T>
where
    T: TypedEcsData,
{ /* private fields */ }

A mutable borrow of AtomicComponentStore.

Implementations

impl<'a, T> AtomicComponentStoreRefMut<'a, T>

where T: TypedEcsData,

pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>

Inserts a component for the given Entity index.

Returns the previous component, if any.

pub fn get(&self, entity: Entity) -> Option<&T>

Gets an immutable reference to the component of Entity.

pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>

Gets a mutable reference to the component of Entity.

pub fn get_many_mut<const N: usize>( &mut self, entities: [Entity; N], ) -> [Option<&mut T>; N]

Get mutable pointers to the component data for multiple entities at the same time.

Panics

This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.

pub fn remove(&mut self, entity: Entity) -> Option<T>

Removes the component of Entity.

Returns the component that was on the entity, if any.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates immutably over all components of this type.

Very fast but doesn’t allow joining with other component types.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterates mutably over all components of this type.

Very fast but doesn’t allow joining with other component types.

pub fn iter_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> ComponentBitsetIterator<'_, 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( &mut self, bitset: Rc<BitSetVec>, ) -> ComponentBitsetIteratorMut<'_, 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

Get the bitset representing which entities have this component on it.

pub fn contains(&self, entity: Entity) -> bool

Check whether or not this component store has data for the given entity.

Trait Implementations

impl<'a, 'q, T> QueryItem for &'a AtomicComponentStoreRefMut<'q, T>

where T: TypedEcsData,

type Iter = ComponentBitsetIterator<'a, T>

The type of iterator this query item creates

fn apply_bitset(&self, bitset: &mut BitSetVec)

Modify the iteration bitset

fn iter_with_bitset( self, bitset: Rc<BitSetVec>, ) -> <&'a AtomicComponentStoreRefMut<'q, T> as QueryItem>::Iter

Return an iterator over the provided bitset.

impl<'a, 'q, T> QueryItem for &'a mut AtomicComponentStoreRefMut<'q, T>

where T: TypedEcsData,

type Iter = ComponentBitsetIteratorMut<'a, T>

The type of iterator this query item creates

fn apply_bitset(&self, bitset: &mut BitSetVec)

Modify the iteration bitset

fn iter_with_bitset( self, bitset: Rc<BitSetVec>, ) -> <&'a mut AtomicComponentStoreRefMut<'q, T> as QueryItem>::Iter

Return an iterator over the provided bitset.

impl<'a, T> SystemParam for AtomicComponentStoreRefMut<'a, T>

where T: TypedEcsData,

type State = AtomicComponentStore<T>

The intermediate state for the parameter, that may be extracted from the world.

type Param<'p> = AtomicComponentStoreRefMut<'p, T>

The type of the parameter, ranging over the lifetime of the intermediate state.

fn initialize(world: &mut World)

This will be called to give the parameter a chance to initialize it’s world storage.

fn get_state( world: &World, ) -> <AtomicComponentStoreRefMut<'a, T> as SystemParam>::State

This is called to produce the intermediate state of the system parameter.

fn borrow( state: &mut <AtomicComponentStoreRefMut<'a, T> as SystemParam>::State, ) -> <AtomicComponentStoreRefMut<'a, T> as SystemParam>::Param<'_>

This is used create an instance of the system parame, possibly borrowed from the intermediate parameter state.