Struct EntityClonerBuilder

pub struct EntityClonerBuilder<'w> { /* private fields */ }

A builder for configuring EntityCloner. See EntityCloner for more information.

Implementations

impl<'w> EntityClonerBuilder<'w>

pub fn clone_entity(&mut self, source: Entity, target: Entity) -> &mut Self

Internally calls EntityCloner::clone_entity on the builder’s World.

pub fn finish(self) -> EntityCloner

Finishes configuring EntityCloner returns it.

pub fn without_required_components( &mut self, builder: impl FnOnce(&mut EntityClonerBuilder<'_>), ) -> &mut Self

By default, any components allowed/denied through the filter will automatically allow/deny all of their required components.

This method allows for a scoped mode where any changes to the filter will not involve required components.

pub fn with_default_clone_fn(&mut self, clone_fn: ComponentCloneFn) -> &mut Self

Sets the default clone function to use.

pub fn move_components(&mut self, enable: bool) -> &mut Self

Sets whether the cloner should remove any components that were cloned, effectively moving them from the source entity to the target.

This is disabled by default.

The setting only applies to components that are allowed through the filter at the time EntityClonerBuilder::clone_entity is called.

pub fn allow<T: Bundle>(&mut self) -> &mut Self

Adds all components of the bundle to the list of components to clone.

Note that all components are allowed by default, to clone only explicitly allowed components make sure to call deny_all before calling any of the allow methods.

pub fn allow_by_ids( &mut self, ids: impl IntoIterator<Item = ComponentId>, ) -> &mut Self

Extends the list of components to clone.

Note that all components are allowed by default, to clone only explicitly allowed components make sure to call deny_all before calling any of the allow methods.

pub fn allow_by_type_ids( &mut self, ids: impl IntoIterator<Item = TypeId>, ) -> &mut Self

Extends the list of components to clone using TypeIds.

Note that all components are allowed by default, to clone only explicitly allowed components make sure to call deny_all before calling any of the allow methods.

pub fn allow_all(&mut self) -> &mut Self

Resets the filter to allow all components to be cloned.

pub fn deny<T: Bundle>(&mut self) -> &mut Self

Disallows all components of the bundle from being cloned.

pub fn deny_by_ids( &mut self, ids: impl IntoIterator<Item = ComponentId>, ) -> &mut Self

Extends the list of components that shouldn’t be cloned.

pub fn deny_by_type_ids( &mut self, ids: impl IntoIterator<Item = TypeId>, ) -> &mut Self

Extends the list of components that shouldn’t be cloned by type ids.

pub fn deny_all(&mut self) -> &mut Self

Sets the filter to deny all components.

pub fn override_clone_behavior<T: Component>( &mut self, clone_behavior: ComponentCloneBehavior, ) -> &mut Self

Overrides the ComponentCloneBehavior for a component in this builder. This handler will be used to clone the component instead of the global one defined by the EntityCloner.

See Handlers section of EntityClonerBuilder to understand how this affects handler priority.

pub fn override_clone_behavior_with_id( &mut self, component_id: ComponentId, clone_behavior: ComponentCloneBehavior, ) -> &mut Self

Overrides the ComponentCloneBehavior for a component with the given component_id in this builder. This handler will be used to clone the component instead of the global one defined by the EntityCloner.

See Handlers section of EntityClonerBuilder to understand how this affects handler priority.

pub fn remove_clone_behavior_override<T: Component>(&mut self) -> &mut Self

Removes a previously set override of ComponentCloneBehavior for a component in this builder.

pub fn remove_clone_behavior_override_with_id( &mut self, component_id: ComponentId, ) -> &mut Self

Removes a previously set override of ComponentCloneBehavior for a given component_id in this builder.

pub fn linked_cloning(&mut self, linked_cloning: bool) -> &mut Self

When true this cloner will be configured to clone entities referenced in cloned components via RelationshipTarget::LINKED_SPAWN. This will produce “deep” / recursive clones of relationship trees that have “linked spawn”.

impl EntityClonerBuilder<'_>

pub fn add_observers(&mut self, add_observers: bool) -> &mut Self

Sets the option to automatically add cloned entities to the observers targeting source entity.