Struct arcs::commands::ChangeRecorder

pub struct ChangeRecorder<'world> { /* fields omitted */ }

A wrapper around a World which records any changes that are made.

Methods

impl<'world> ChangeRecorder<'world>

pub fn new(world: &'world World) -> Self

pub fn create_entity(&mut self) -> Builder

Create a new Entity.

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

Delete an Entity and any components associated with it.

pub fn set_component<C: Component + Clone>(
    &mut self,
    entity: Entity,
    component: C
)

Associate a new Component with a particular Entity.

pub fn get_component<C: Component + Clone>(&self, entity: Entity) -> Option<C>

Look up the Component associated with an Entity.

This performs a copy because 9 times out of 10 you'll mutate the value and pass it to ChangeRecorder::set_component() anyway... plus the borrow checker complains because we save where the component is stored as a local and returning &C would lead to dangling pointers.

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

Removes a Component from this Entity.

pub fn into_changes(self) -> ChangeSet

Extract the list of [Change]s.