[−]Struct oxygengine::core::ecs::changeset::ChangeSet
Change set that can be collected from an iterator, and joined on for easy application to components.
Example
pub struct Health(i32); impl Component for Health { type Storage = DenseVecStorage<Self>; } let a = world.create_entity().with(Health(100)).build(); let b = world.create_entity().with(Health(200)).build(); let changeset = [(a, 32), (b, 12), (b, 13)] .iter() .cloned() .collect::<ChangeSet<i32>>(); for (health, modifier) in (&mut world.write_storage::<Health>(), &changeset).join() { health.0 -= modifier; }
Methods
impl<T> ChangeSet<T>
pub fn new() -> ChangeSet<T>
Create a new change set
pub fn add(&mut self, entity: Entity, value: T) where
T: AddAssign<T>,
T: AddAssign<T>,
Add a value to the change set. If the entity already have a value in the change set, the incoming value will be added to that.
pub fn clear(&mut self)
Clear the changeset
Trait Implementations
impl<T> FromIterator<(Entity, T)> for ChangeSet<T> where
T: AddAssign<T>,
T: AddAssign<T>,
impl<T> Default for ChangeSet<T>
impl<'a, T> Join for &'a mut ChangeSet<T>
type Type = &'a mut T
Type of joined components.
type Value = &'a mut DenseVecStorage<T>
Type of joined storages.
type Mask = &'a BitSet
Type of joined bit mask.
unsafe fn open(
self
) -> (<&'a mut ChangeSet<T> as Join>::Mask, <&'a mut ChangeSet<T> as Join>::Value)
self
) -> (<&'a mut ChangeSet<T> as Join>::Mask, <&'a mut ChangeSet<T> as Join>::Value)
unsafe fn get(
v: &mut <&'a mut ChangeSet<T> as Join>::Value,
id: u32
) -> <&'a mut ChangeSet<T> as Join>::Type
v: &mut <&'a mut ChangeSet<T> as Join>::Value,
id: u32
) -> <&'a mut ChangeSet<T> as Join>::Type
ⓘImportant traits for JoinIter<J>fn join(self) -> JoinIter<Self>
Create a joined iterator over the contents.
fn maybe(self) -> MaybeJoin<Self>
Returns a Join
-able structure that yields all indices, returning None
for all missing elements and Some(T)
for found elements. Read more
fn is_unconstrained() -> bool
If this Join
typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter
/ParJoin
to go through all indices which is usually not what is wanted and will kill performance. Read more
impl<'a, T> Join for &'a ChangeSet<T>
type Type = &'a T
Type of joined components.
type Value = &'a DenseVecStorage<T>
Type of joined storages.
type Mask = &'a BitSet
Type of joined bit mask.
unsafe fn open(
self
) -> (<&'a ChangeSet<T> as Join>::Mask, <&'a ChangeSet<T> as Join>::Value)
self
) -> (<&'a ChangeSet<T> as Join>::Mask, <&'a ChangeSet<T> as Join>::Value)
unsafe fn get(
value: &mut <&'a ChangeSet<T> as Join>::Value,
id: u32
) -> <&'a ChangeSet<T> as Join>::Type
value: &mut <&'a ChangeSet<T> as Join>::Value,
id: u32
) -> <&'a ChangeSet<T> as Join>::Type
ⓘImportant traits for JoinIter<J>fn join(self) -> JoinIter<Self>
Create a joined iterator over the contents.
fn maybe(self) -> MaybeJoin<Self>
Returns a Join
-able structure that yields all indices, returning None
for all missing elements and Some(T)
for found elements. Read more
fn is_unconstrained() -> bool
If this Join
typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter
/ParJoin
to go through all indices which is usually not what is wanted and will kill performance. Read more
impl<T> Join for ChangeSet<T>
type Type = T
Type of joined components.
type Value = DenseVecStorage<T>
Type of joined storages.
type Mask = BitSet
Type of joined bit mask.
unsafe fn open(
self
) -> (<ChangeSet<T> as Join>::Mask, <ChangeSet<T> as Join>::Value)
self
) -> (<ChangeSet<T> as Join>::Mask, <ChangeSet<T> as Join>::Value)
unsafe fn get(
value: &mut <ChangeSet<T> as Join>::Value,
id: u32
) -> <ChangeSet<T> as Join>::Type
value: &mut <ChangeSet<T> as Join>::Value,
id: u32
) -> <ChangeSet<T> as Join>::Type
ⓘImportant traits for JoinIter<J>fn join(self) -> JoinIter<Self>
Create a joined iterator over the contents.
fn maybe(self) -> MaybeJoin<Self>
Returns a Join
-able structure that yields all indices, returning None
for all missing elements and Some(T)
for found elements. Read more
fn is_unconstrained() -> bool
If this Join
typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter
/ParJoin
to go through all indices which is usually not what is wanted and will kill performance. Read more
impl<T> Extend<(Entity, T)> for ChangeSet<T> where
T: AddAssign<T>,
T: AddAssign<T>,
fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = (Entity, T)>,
I: IntoIterator<Item = (Entity, T)>,
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
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.
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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Resource for T where
T: Any + Send + Sync,
T: Any + Send + Sync,
impl<T> Any for T where
T: Any,
T: Any,
fn get_type_id(&self) -> TypeId
impl<T> TryDefault for T where
T: Default,
T: Default,
fn try_default() -> Result<T, String>
fn unwrap_default() -> Self
Calls try_default
and panics on an error case.
impl<T> Event for T where
T: Send + Sync + 'static,
T: Send + Sync + 'static,