Struct legion::systems::CommandBuffer
source · [−]pub struct CommandBuffer { /* private fields */ }
Expand description
A command buffer used to queue mutable changes to the world from a system. This buffer is automatically
flushed and refreshed at the beginning of every frame by Schedule
. If Schedule
is not used,
then the user needs to manually flush it by performing CommandBuffer::flush
.
Examples
Inserting an entity using the CommandBuffer
:
let mut command_buffer = CommandBuffer::new(&world);
let entity = command_buffer.push(());
command_buffer.add_component(entity, Position(123.0));
command_buffer.remove(entity);
command_buffer.flush(&mut world, &mut resources);
Implementations
sourceimpl CommandBuffer
impl CommandBuffer
sourcepub fn flush(&mut self, world: &mut World, resources: &mut Resources)
pub fn flush(&mut self, world: &mut World, resources: &mut Resources)
Flushes this command buffer, draining all stored commands and writing them to the world.
Command flushes are performed in a FIFO manner, allowing for reliable, linear commands being executed in the order they were provided.
sourcepub fn exec_mut<F>(&mut self, f: F) where
F: 'static + Fn(&mut World, &mut Resources) + Send + Sync,
pub fn exec_mut<F>(&mut self, f: F) where
F: 'static + Fn(&mut World, &mut Resources) + Send + Sync,
Executes an arbitrary closure against the mutable world, allowing for queued exclusive access to the world.
sourcepub fn push<T>(&mut self, components: T) -> Entity where
Option<T>: 'static + IntoComponentSource,
<Option<T> as IntoComponentSource>::Source: KnownLength + Send + Sync,
pub fn push<T>(&mut self, components: T) -> Entity where
Option<T>: 'static + IntoComponentSource,
<Option<T> as IntoComponentSource>::Source: KnownLength + Send + Sync,
Queues the insertion of a single entity into the world.
sourcepub fn extend<T>(&mut self, components: T) -> &[Entity] where
T: 'static + IntoComponentSource,
<T as IntoComponentSource>::Source: KnownLength + Send + Sync,
pub fn extend<T>(&mut self, components: T) -> &[Entity] where
T: 'static + IntoComponentSource,
<T as IntoComponentSource>::Source: KnownLength + Send + Sync,
Queues the insertion of new entities into the world.
sourcepub fn remove(&mut self, entity: Entity)
pub fn remove(&mut self, entity: Entity)
Queues the deletion of an entity in the command buffer.
sourcepub fn add_component<C: Component>(&mut self, entity: Entity, component: C)
pub fn add_component<C: Component>(&mut self, entity: Entity, component: C)
Queues the addition of a component from an entity in the command buffer.
sourcepub fn remove_component<C: Component>(&mut self, entity: Entity)
pub fn remove_component<C: Component>(&mut self, entity: Entity)
Queues the removal of a component from an entity in the command buffer.
Auto Trait Implementations
impl !RefUnwindSafe for CommandBuffer
impl Send for CommandBuffer
impl Sync for CommandBuffer
impl Unpin for CommandBuffer
impl !UnwindSafe for CommandBuffer
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcepub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcepub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcepub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcepub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more