Struct ApplierRef

pub struct ApplierRef<'w, 'i> { /* private fields */ }

Available on crate feature reflect only.

ApplierRef lets you configure how a snapshot will be applied to the World.

Implementations

impl<'w, 'i> ApplierRef<'w, 'i>

pub fn new( snapshot: impl Into<MaybeRef<'i, Snapshot>>, world: &'w mut World, ) -> Self

Create a new ApplierRef from the world and borrowed or owned Snapshot.

pub fn from_parts(world: &'w mut World, input: Applier<'i>) -> Self

Create a new ApplierRef from the world and input.

pub fn into_inner(self) -> Applier<'i>

Reduce the applier into its input

impl<'i> ApplierRef<'_, 'i>

pub fn entity_map( self, entity_map: impl Into<MaybeMut<'i, EntityHashMap<Entity>>>, ) -> Self

Providing an entity map allows you to map ids of spawned entities and see what entities have been spawned.

pub fn type_registry(self, type_registry: &'i TypeRegistry) -> Self

Set the TypeRegistry to be used for reflection.

If this is not provided, the AppTypeRegistry resource is used as a default.

pub fn despawn<F: QueryFilter + 'static>(self) -> Self

Despawn existing entities matching the filter while applying.

pub fn hook(self, hook: impl Hook + 'static) -> Self

Add a Hook that will run for each entity after applying.

pub fn prefab<P: Prefab + FromReflect>(self) -> Self

Handle loading for a Prefab.

impl ApplierRef<'_, '_>

pub fn apply(&mut self) -> Result<(), Error>

Apply the Snapshot to the World.

Panics

If type_registry is not set or the AppTypeRegistry resource does not exist.

Errors

If a type included in the Snapshot has not been registered with the type registry.