Struct CommandBuffer

pub struct CommandBuffer { /* private fields */ }

A buffer of deferred ECS commands such as entity creation, component addition/removal, and destruction.

This is useful for queuing up changes during system execution to avoid mutably borrowing the world while it’s being accessed elsewhere. Changes can be applied all at once using CommandBuffer::execute.

Fields

• commands: The queued operations to apply.

Safety

• Commands are applied with exclusive access to the World to ensure memory safety.

Implementations

impl CommandBuffer

pub fn clear(&mut self)

Clears the buffer

pub fn create_entity(&mut self)

Queues a command to create a new entity in the world. The entity will be returned by execute when the command is applied.

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

Queues a command to destroy an entity. This will remove all of its components and make its ID reusable.

Parameters

• entity: The entity to be destroyed.

pub fn add_component<T: Component + Send + 'static>( &mut self, entity: Entity, component: T, )

Queues a command to add a component to an entity. The command is deferred to avoid borrowing issues during system execution.

Type Parameters

• T: The component type.

Parameters

• entity: The entity to receive the component.
• component: The component instance to be added.

pub fn remove_component<T: Component + 'static>(&mut self, entity: Entity)

Queues a command to remove a component of type T from an entity.

Type Parameters

• T: The component type to remove.

Parameters

• entity: The entity from which to remove the component.

pub fn create_entity_and_add_component<T: Component + Send + 'static>( &mut self, component: T, )

Queues a command to create a new entity and immediately add a component to it.

Type Parameters

• T: The component type.

Parameters

• component: The component instance to be added to the new entity.

pub fn execute(&mut self, world: &mut World) -> Vec<Entity>

Executes all queued commands in order, applying them to the world.

Returns a vector of entities created via create_entity for further tracking.

Parameters

• world: The world to apply the commands to.

Trait Implementations

impl Default for CommandBuffer

fn default() -> CommandBuffer

Returns the “default value” for a type.