Struct flatbox_ecs::CommandBuffer
source · pub struct CommandBuffer { /* private fields */ }
Expand description
Extends the built in hecs::CommandBuffer.
Allows for deferred modifications to the world, spawn, insert, remove, despawn, or custom closures.
It is possible to insert a commandbuffer into another commandbuffer.
Implementations§
source§impl CommandBuffer
impl CommandBuffer
sourcepub fn new() -> CommandBuffer
pub fn new() -> CommandBuffer
Creates a new empty commandbuffer
sourcepub fn insert(&mut self, entity: Entity, components: impl DynamicBundle)
pub fn insert(&mut self, entity: Entity, components: impl DynamicBundle)
Inserts components into an already existing or reserved entity
sourcepub fn insert_one(&mut self, entity: Entity, component: impl Component)
pub fn insert_one(&mut self, entity: Entity, component: impl Component)
Inserts a single component into an already existing or reserved entity
sourcepub fn spawn(&mut self, components: impl DynamicBundle)
pub fn spawn(&mut self, components: impl DynamicBundle)
Spawns a new entity with components. If the entity ID is desired, consider reserving an entity and then inserting
sourcepub fn remove_one<C>(&mut self, entity: Entity)where
C: Component,
pub fn remove_one<C>(&mut self, entity: Entity)where
C: Component,
Remove a single component from the world
sourcepub fn append(&mut self, other: CommandBuffer)
pub fn append(&mut self, other: CommandBuffer)
Nest a commandbuffer
Trait Implementations§
source§impl Default for CommandBuffer
impl Default for CommandBuffer
source§fn default() -> CommandBuffer
fn default() -> CommandBuffer
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for CommandBuffer
impl !RefUnwindSafe for CommandBuffer
impl Send for CommandBuffer
impl Sync for CommandBuffer
impl Unpin for CommandBuffer
impl !UnwindSafe for CommandBuffer
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for T
impl<T> Downcast for T
source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.