Trait oxygengine_core::ecs::storage::GenericWriteStorage

pub trait GenericWriteStorage {
    type Component: Component;
    fn get_mut(&mut self, entity: Entity) -> Option<&mut Self::Component>;
    fn get_mut_or_default(
        &mut self, 
        entity: Entity
    ) -> Option<&mut Self::Component>
    where
        Self::Component: Default;
    fn insert(
        &mut self, 
        entity: Entity, 
        comp: Self::Component
    ) -> Result<Option<Self::Component>, Error>;
    fn remove(&mut self, entity: Entity);
    fn _private() -> Seal;
}

Provides generic write access to WriteStorage, both as a value and a mutable reference.

Associated Types

type Component: Component

The component type of the storage

Required methods

fn get_mut(&mut self, entity: Entity) -> Option<&mut Self::Component>

Get mutable access to an Entitys component

fn get_mut_or_default(&mut self, entity: Entity) -> Option<&mut Self::Component> where
    Self::Component: Default, 

Get mutable access to an Entitys component. If the component does not exist, it is automatically created using Default::default().

Returns None if the entity is dead.

fn insert(
    &mut self,
    entity: Entity,
    comp: Self::Component
) -> Result<Option<Self::Component>, Error>

Insert a component for an Entity

fn remove(&mut self, entity: Entity)

Remove the component for an Entity

fn _private() -> Seal

Private function to seal the trait

Implementors

impl<'a, 'b, T> GenericWriteStorage for &'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> where
    'a: 'b,
    T: Component, 

type Component = T

pub fn get_mut(
    &mut self,
    entity: Entity
) -> Option<&mut <&'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component>

pub fn get_mut_or_default(
    &mut self,
    entity: Entity
) -> Option<&mut <&'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component> where
    <&'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component: Default, 

pub fn insert(
    &mut self,
    entity: Entity,
    comp: <&'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component
) -> Result<Option<<&'b mut Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component>, Error>

pub fn remove(&mut self, entity: Entity)

pub fn _private() -> Seal

impl<'a, T> GenericWriteStorage for Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> where
    T: Component, 

type Component = T

pub fn get_mut(
    &mut self,
    entity: Entity
) -> Option<&mut <Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component>

pub fn get_mut_or_default(
    &mut self,
    entity: Entity
) -> Option<&mut <Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component> where
    <Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component: Default, 

pub fn insert(
    &mut self,
    entity: Entity,
    comp: <Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component
) -> Result<Option<<Storage<'a, T, FetchMut<'a, MaskedStorage<T>>> as GenericWriteStorage>::Component>, Error>

pub fn remove(&mut self, entity: Entity)

pub fn _private() -> Seal