pub struct EntityClonerBuilder<'w, Filter> { /* private fields */ }
Expand description
A builder for configuring EntityCloner
. See EntityCloner
for more information.
Implementations§
Source§impl<'w, Filter: CloneByFilter> EntityClonerBuilder<'w, Filter>
impl<'w, Filter: CloneByFilter> EntityClonerBuilder<'w, Filter>
Sourcepub fn clone_entity(&mut self, source: Entity, target: Entity) -> &mut Self
pub fn clone_entity(&mut self, source: Entity, target: Entity) -> &mut Self
Internally calls EntityCloner::clone_entity
on the builder’s World
.
Sourcepub fn finish(self) -> EntityCloner
pub fn finish(self) -> EntityCloner
Finishes configuring EntityCloner
returns it.
Sourcepub fn with_default_clone_fn(&mut self, clone_fn: ComponentCloneFn) -> &mut Self
pub fn with_default_clone_fn(&mut self, clone_fn: ComponentCloneFn) -> &mut Self
Sets the default clone function to use.
Will be overridden if EntityClonerBuilder::move_components
is enabled.
Sourcepub fn move_components(&mut self, enable: bool) -> &mut Self
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.
Enabling this overrides any custom function set with EntityClonerBuilder::with_default_clone_fn
.
Sourcepub fn override_clone_behavior<T: Component>(
&mut self,
clone_behavior: ComponentCloneBehavior,
) -> &mut Self
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.
Sourcepub fn override_clone_behavior_with_id(
&mut self,
component_id: ComponentId,
clone_behavior: ComponentCloneBehavior,
) -> &mut Self
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.
Sourcepub fn remove_clone_behavior_override<T: Component>(&mut self) -> &mut Self
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.
Sourcepub fn remove_clone_behavior_override_with_id(
&mut self,
component_id: ComponentId,
) -> &mut Self
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.
Sourcepub fn linked_cloning(&mut self, linked_cloning: bool) -> &mut Self
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”.
Source§impl<'w> EntityClonerBuilder<'w, OptOut>
impl<'w> EntityClonerBuilder<'w, OptOut>
Sourcepub fn without_required_by_components(
&mut self,
builder: impl FnOnce(&mut Self),
) -> &mut Self
pub fn without_required_by_components( &mut self, builder: impl FnOnce(&mut Self), ) -> &mut Self
By default, any components denied through the filter will automatically deny all of components they are required by too.
This method allows for a scoped mode where any changes to the filter will not involve these requiring components.
If component A
is denied in the builder
closure here and component B
requires A
, then A
will be inserted with the value defined in B
’s
Component
derive.
This assumes A
is missing yet at the target entity.
Sourcepub fn insert_mode(&mut self, insert_mode: InsertMode) -> &mut Self
pub fn insert_mode(&mut self, insert_mode: InsertMode) -> &mut Self
Sets whether components are always cloned (InsertMode::Replace
, the default) or only if it is missing
(InsertMode::Keep
) at the target entity.
This makes no difference if the target is spawned by the cloner.
Sourcepub fn deny<T: Bundle>(&mut self) -> &mut Self
pub fn deny<T: Bundle>(&mut self) -> &mut Self
Disallows all components of the bundle from being cloned.
If component A
is denied here and component B
requires A
, then A
is denied as well. See Self::without_required_by_components
to alter
this behavior.
Sourcepub fn deny_by_ids<M: Marker>(
&mut self,
ids: impl FilterableIds<M>,
) -> &mut Self
pub fn deny_by_ids<M: Marker>( &mut self, ids: impl FilterableIds<M>, ) -> &mut Self
Extends the list of components that shouldn’t be cloned.
Supports filtering by TypeId
, ComponentId
, BundleId
, and IntoIterator
yielding one of these.
If component A
is denied here and component B
requires A
, then A
is denied as well. See Self::without_required_by_components
to alter
this behavior.
Source§impl<'w> EntityClonerBuilder<'w, OptIn>
impl<'w> EntityClonerBuilder<'w, OptIn>
Sourcepub fn without_required_components(
&mut self,
builder: impl FnOnce(&mut Self),
) -> &mut Self
pub fn without_required_components( &mut self, builder: impl FnOnce(&mut Self), ) -> &mut Self
By default, any components allowed through the filter will automatically allow all of their required components.
This method allows for a scoped mode where any changes to the filter will not involve required components.
If component A
is allowed in the builder
closure here and requires
component B
, then B
will be inserted with the value defined in A
’s
Component
derive.
This assumes B
is missing yet at the target entity.
Sourcepub fn allow<T: Bundle>(&mut self) -> &mut Self
pub fn allow<T: Bundle>(&mut self) -> &mut Self
Adds all components of the bundle to the list of components to clone.
If component A
is allowed here and requires component B
, then B
is allowed as well. See Self::without_required_components
to alter this behavior.
Sourcepub fn allow_if_new<T: Bundle>(&mut self) -> &mut Self
pub fn allow_if_new<T: Bundle>(&mut self) -> &mut Self
Adds all components of the bundle to the list of components to clone if the target does not contain them.
If component A
is allowed here and requires component B
, then B
is allowed as well. See Self::without_required_components
to alter this behavior.
Sourcepub fn allow_by_ids<M: Marker>(
&mut self,
ids: impl FilterableIds<M>,
) -> &mut Self
pub fn allow_by_ids<M: Marker>( &mut self, ids: impl FilterableIds<M>, ) -> &mut Self
Extends the list of components to clone.
Supports filtering by TypeId
, ComponentId
, BundleId
, and IntoIterator
yielding one of these.
If component A
is allowed here and requires component B
, then B
is allowed as well. See Self::without_required_components
to alter this behavior.
Sourcepub fn allow_by_ids_if_new<M: Marker>(
&mut self,
ids: impl FilterableIds<M>,
) -> &mut Self
pub fn allow_by_ids_if_new<M: Marker>( &mut self, ids: impl FilterableIds<M>, ) -> &mut Self
Extends the list of components to clone if the target does not contain them.
Supports filtering by TypeId
, ComponentId
, BundleId
, and IntoIterator
yielding one of these.
If component A
is allowed here and requires component B
, then B
is allowed as well. See Self::without_required_components
to alter this behavior.
Source§impl<Filter: CloneByFilter> EntityClonerBuilder<'_, Filter>
impl<Filter: CloneByFilter> EntityClonerBuilder<'_, Filter>
Sourcepub fn add_observers(&mut self, add_observers: bool) -> &mut Self
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.
Auto Trait Implementations§
impl<'w, Filter> Freeze for EntityClonerBuilder<'w, Filter>where
Filter: Freeze,
impl<'w, Filter> !RefUnwindSafe for EntityClonerBuilder<'w, Filter>
impl<'w, Filter> !Send for EntityClonerBuilder<'w, Filter>
impl<'w, Filter> !Sync for EntityClonerBuilder<'w, Filter>
impl<'w, Filter> Unpin for EntityClonerBuilder<'w, Filter>where
Filter: Unpin,
impl<'w, Filter> !UnwindSafe for EntityClonerBuilder<'w, Filter>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.