Struct hecs_schedule::CommandBuffer

pub struct CommandBuffer { /* private fields */ }

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

impl CommandBuffer

pub fn new() -> Self

Creates a new empty commandbuffer

pub fn insert(&mut self, entity: Entity, components: impl DynamicBundle)

Inserts components into an already existing or reserved entity

pub fn insert_one(&mut self, entity: Entity, component: impl Component)

Inserts a single component into an already existing or reserved entity

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

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

Despawn an entity from the world

pub fn remove<C: Component + Bundle>(&mut self, entity: Entity)

Remove components from entity

pub fn remove_one<C: Component>(&mut self, entity: Entity)

Remove a single component from the world

pub fn execute(&mut self, world: &mut World)

Applies the recorded commands on the world

pub fn append(&mut self, other: Self)

Nest a commandbuffer

pub fn write(&mut self, cmd: impl FnOnce(&mut World) + Component)

Record a custom command modifying the world

pub fn clear(&mut self)

Drop all recorded commands

Trait Implementations

impl Default for CommandBuffer

fn default() -> CommandBuffer

Returns the “default value” for a type.