pub struct CommandScope<'a, 'w, 's, E> { /* private fields */ }Expand description
Builder API to construct hierarchies of relations from commands.
use bevy::prelude::*;
use aery::prelude::*;
#[derive(Relation)]
struct ChildOf;
#[derive(Component)]
struct C<const N: usize>;
fn sys(mut cmds: Commands) {
cmds.spawn(C::<0>)
.scope::<ChildOf>(|scope| {
// 1, 2, 3 are implicitly `ChildOf` the last spawned entity (0)
scope.add(C::<1>)
.add(C::<2>)
.add(C::<3>)
.scope::<ChildOf>(|scope| {
// 4, 5 are implicitly `ChildOf` the last spawned entity (3)
scope.add(C::<4>)
.add(C::<5>);
});
});
}Implementations§
Source§impl<T: Relation> CommandScope<'_, '_, '_, T>
impl<T: Relation> CommandScope<'_, '_, '_, T>
Sourcepub fn scope<R: Relation>(
&mut self,
func: impl FnMut(&mut CommandScope<'_, '_, '_, R>),
) -> &mut Self
pub fn scope<R: Relation>( &mut self, func: impl FnMut(&mut CommandScope<'_, '_, '_, R>), ) -> &mut Self
Scope the last spawned entity via R. Any targets or hosts that are added in the scope
implicitly use R as the edge.
Source§impl<R: Relation> CommandScope<'_, '_, '_, R>
impl<R: Relation> CommandScope<'_, '_, '_, R>
Sourcepub fn add(&mut self, bundle: impl Bundle) -> &mut Self
pub fn add(&mut self, bundle: impl Bundle) -> &mut Self
Spawn an entity from a bundle and have it target the currently scoped entity via R.
Sourcepub fn add_target(&mut self, bundle: impl Bundle) -> &mut Self
pub fn add_target(&mut self, bundle: impl Bundle) -> &mut Self
Spawn an entity from a bundle and set it as a target of the currently scoped entity.
Sourcepub fn add_and(
&mut self,
func: impl for<'a> FnMut(&mut EntityCommands<'a>),
) -> &mut Self
pub fn add_and( &mut self, func: impl for<'a> FnMut(&mut EntityCommands<'a>), ) -> &mut Self
Spawn an entity and have it target the currently scoped entity via. This function takes a closure to provide entity mut access.
Sourcepub fn add_target_and(
&mut self,
func: impl for<'a> FnMut(&mut EntityCommands<'a>),
) -> &mut Self
pub fn add_target_and( &mut self, func: impl for<'a> FnMut(&mut EntityCommands<'a>), ) -> &mut Self
Spawn an entity and set it as a target of the currently scoped entity. This function takes a closure to provide entity mut access.
Auto Trait Implementations§
impl<'a, 'w, 's, E> Freeze for CommandScope<'a, 'w, 's, E>
impl<'a, 'w, 's, E> RefUnwindSafe for CommandScope<'a, 'w, 's, E>where
E: RefUnwindSafe,
impl<'a, 'w, 's, E> Send for CommandScope<'a, 'w, 's, E>where
E: Send,
impl<'a, 'w, 's, E> Sync for CommandScope<'a, 'w, 's, E>where
E: Sync,
impl<'a, 'w, 's, E> Unpin for CommandScope<'a, 'w, 's, E>where
E: Unpin,
impl<'a, 'w, 's, E> !UnwindSafe for CommandScope<'a, 'w, 's, E>
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
Mutably borrows from an owned value. Read more
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>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<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>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> 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)
Convert
&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)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.