Struct ActionEncoder

pub struct ActionEncoder<'a> { /* private fields */ }

Encoder for actions that require mutable access to World, like spawning/despawning entities and inserting/removing/dropping components and relations.

Systems may declare ActionEncoder argument to record actions that will be executed later. Each system will get its own ActionEncoder instance, so no conflicts will be caused by this argument. In contract &mut World argument will cause system to conflict with all other systems, reducing parallelism.

Provided to component and relation hooks.

Implementations

impl<'a> ActionEncoder<'a>

pub fn is_empty(&self) -> bool

Returns true if attached action buffer is empty. That is, no actions were recorded.

pub fn allocate(&self) -> EntityLoc<'_>

Allocates new entity id that can be used with following actions.

pub fn spawn_one<T>(&mut self, component: T) -> EntityLoc<'_>

where T: Component + Send + 'static,

Allocates new entity id and encodes an action to insert bundle to the entity.

pub fn spawn<B>(&mut self, bundle: B) -> EntityLoc<'_>

where B: DynamicComponentBundle + Send + 'static,

Allocates new entity id and encodes an action to insert bundle to the entity.

pub fn spawn_external<B>(&mut self, bundle: B) -> EntityLoc<'_>

where B: DynamicBundle + Send + 'static,

Allocates new entity id and encodes an action to insert bundle to the entity.

pub fn spawn_batch<I>(&mut self, bundles: I) -> SpawnBatch<'_, I>

where I: IntoIterator, I::Item: ComponentBundle + Send + 'static,

Returns an iterator which encodes action to spawn and yield entities using bundles yielded from provided bundles iterator.

pub fn spawn_external_batch<I>(&mut self, bundles: I) -> SpawnBatch<'_, I>

where I: IntoIterator, I::Item: Bundle + Send + 'static,

Returns an iterator which encodes action to spawn and yield entities using bundles yielded from provided bundles iterator.

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

Encodes an action to despawn specified entity.

pub fn despawn_batch(&mut self, entities: impl IntoIterator<Item = EntityId>)

Encodes an action to despawn entities in batch.

pub fn insert<T>(&mut self, entity: impl Entity, component: T)

where T: Component + Send,

Encodes an action to insert component to the specified entity.

pub fn insert_external<T>(&mut self, entity: impl Entity, component: T)

where T: Send + 'static,

Encodes an action to insert component to the specified entity.

pub fn with<F, T>(&mut self, entity: impl Entity, f: F)

where F: FnOnce() -> T + Send + 'static, T: Component,

Encodes an action to insert component to the specified entity.

pub fn with_external<F, T>(&mut self, entity: impl Entity, f: F)

where F: FnOnce() -> T + Send + 'static, T: 'static,

Encodes an action to insert component to the specified entity.

pub fn insert_bundle<B>(&mut self, entity: impl Entity, bundle: B)

where B: DynamicComponentBundle + Send + 'static,

Encodes an action to insert components from bundle to the specified entity.

pub fn insert_external_bundle<B>(&mut self, entity: impl Entity, bundle: B)

where B: DynamicBundle + Send + 'static,

Encodes an action to insert components from bundle to the specified entity.

pub fn with_bundle<B>(&mut self, entity: impl Entity, bundle: B)

where B: DynamicComponentBundle + Send + 'static,

Encodes an action to insert components from bundle to the specified entity.

pub fn with_external_bundle<B>(&mut self, entity: impl Entity, bundle: B)

where B: DynamicBundle + Send + 'static,

Encodes an action to insert components from bundle to the specified entity.

pub fn drop<T>(&mut self, entity: impl Entity)

where T: 'static,

Encodes an action to drop component from specified entity.

pub fn drop_batch<T>(&mut self, entities: impl IntoIterator<Item = EntityId>)

where T: 'static,

Encodes an action to drop component from entities in batch.

pub fn drop_erased(&mut self, entity: impl Entity, ty: TypeId)

Encodes an action to drop component from specified entity.

pub fn drop_erased_batch( &mut self, entities: impl IntoIterator<Item = EntityId>, ty: TypeId, )

Encodes an action to drop component from entities in batch.

pub fn drop_bundle<B>(&mut self, entity: impl Entity)

where B: Bundle,

Encodes an action to drop bundle of components from specified entity.

pub fn insert_relation<R>( &mut self, origin: impl Entity, relation: R, target: impl Entity, )

where R: Relation + Send,

Encodes an action to add relation between two entities to the World.

pub fn drop_relation<R>(&mut self, origin: EntityId, target: EntityId)

where R: Relation,

Encodes an action to drop relation between two entities in the World.

pub fn is_alive(&self, entity: impl Entity) -> bool

Checks if entity is alive.

pub fn insert_resource<T>(&mut self, resource: T)

where T: Send + 'static,

Encodes action to insert resource instance.

pub fn drop_resource<T: 'static>(&mut self)

Encodes an action to drop resource instance.

pub fn closure(&mut self, fun: impl FnOnce(&mut World) + Send + 'static)

Encodes a custom action with a closure that takes reference to World and ActionEncoder that can be used to record new actions.

pub fn reborrow(&mut self) -> ActionEncoder<'_>

Creates new ActionEncoder that records actions into the same ActionBuffer as this one.

Trait Implementations

impl FnArg for ActionEncoder<'_>

type State = ActionEncoderState

State for an argument that is stored between calls to function-system.