Struct legion::systems::CommandBuffer [−][src]
pub struct CommandBuffer { /* fields omitted */ }
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
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.
Executes an arbitrary closure against the mutable world, allowing for queued exclusive access to the world.
pub 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.
pub 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.
Queues the deletion of an entity in the command buffer.
Queues the addition of a component from an entity in the command buffer.
Queues the removal of a component from an entity in the command buffer.
Returns the current number of commands already queued in this CommandBuffer
instance.
Trait Implementations
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
Mutably borrows from an owned value. Read more
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
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
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
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