pub struct Spawn<'a, C = ()> { /* private fields */ }Available on crate feature
ecs only.Expand description
Composable to spawn an entity.
See spawn for more information.
Implementations§
Source§impl<'a, C> Spawn<'a, C>
impl<'a, C> Spawn<'a, C>
Sourcepub fn target(self, target: Entity) -> Self
pub fn target(self, target: Entity) -> Self
Set the target entity to spawn the composition into.
If None, this will use the composition’s parent (if any).
Sourcepub fn on_spawn(self, f: impl Fn(EntityWorldMut<'_>) + 'a) -> Self
pub fn on_spawn(self, f: impl Fn(EntityWorldMut<'_>) + 'a) -> Self
Add a function to be called when this bundle is initially spawned.
Sourcepub fn on_insert(self, f: impl Fn(EntityWorldMut<'_>) + 'a) -> Self
pub fn on_insert(self, f: impl Fn(EntityWorldMut<'_>) + 'a) -> Self
Add a function to be called on every insert.
Sourcepub fn observe<F, E, B, Marker>(self, observer: F) -> Selfwhere
F: SystemParamFunction<Marker, In = On<'static, 'static, E, B>, Out = ()> + Send + Sync + 'a,
E: EntityEvent,
B: Bundle,
pub fn observe<F, E, B, Marker>(self, observer: F) -> Selfwhere
F: SystemParamFunction<Marker, In = On<'static, 'static, E, B>, Out = ()> + Send + Sync + 'a,
E: EntityEvent,
B: Bundle,
Add an observer to the spawned entity.
Trait Implementations§
impl<C: Data> Data for Spawn<'_, C>
Auto Trait Implementations§
impl<'a, C> Freeze for Spawn<'a, C>where
C: Freeze,
impl<'a, C = ()> !RefUnwindSafe for Spawn<'a, C>
impl<'a, C = ()> !Send for Spawn<'a, C>
impl<'a, C = ()> !Sync for Spawn<'a, C>
impl<'a, C> Unpin for Spawn<'a, C>where
C: Unpin,
impl<'a, C = ()> !UnwindSafe for Spawn<'a, C>
Blanket Implementations§
§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§unsafe fn clone_to_uninit(&self, dest: *mut u8)
unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (
clone_to_uninit)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>
Converts
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>
Converts
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)
Converts
&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)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.