Struct cuicui_dsl::EntityCommands
pub struct EntityCommands<'w, 's, 'a> { /* private fields */ }
Expand description
A list of commands that will be run to modify an entity.
Implementations§
§impl<'w, 's, 'a> EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> EntityCommands<'w, 's, 'a>
pub fn id(&self) -> Entity
pub fn id(&self) -> Entity
Returns the [Entity
] id of the entity.
Example
fn my_system(mut commands: Commands) {
let entity_id = commands.spawn_empty().id();
}
pub fn insert(&mut self, bundle: impl Bundle) -> &mut EntityCommands<'w, 's, 'a>
pub fn insert(&mut self, bundle: impl Bundle) -> &mut EntityCommands<'w, 's, 'a>
Adds a [Bundle
] of components to the entity.
This will overwrite any previous value(s) of the same component type.
Panics
The command will panic when applied if the associated entity does not exist.
To avoid a panic in this case, use the command Self::try_insert
instead.
Example
#[derive(Component)]
struct Health(u32);
#[derive(Component)]
struct Strength(u32);
#[derive(Component)]
struct Defense(u32);
#[derive(Bundle)]
struct CombatBundle {
health: Health,
strength: Strength,
}
fn add_combat_stats_system(mut commands: Commands, player: Res<PlayerEntity>) {
commands
.entity(player.entity)
// You can insert individual components:
.insert(Defense(10))
// You can also insert pre-defined bundles of components:
.insert(CombatBundle {
health: Health(100),
strength: Strength(40),
})
// You can also insert tuples of components and bundles.
// This is equivalent to the calls above:
.insert((
Defense(10),
CombatBundle {
health: Health(100),
strength: Strength(40),
},
));
}
pub fn try_insert(
&mut self,
bundle: impl Bundle
) -> &mut EntityCommands<'w, 's, 'a>
pub fn try_insert( &mut self, bundle: impl Bundle ) -> &mut EntityCommands<'w, 's, 'a>
Tries to add a [Bundle
] of components to the entity.
This will overwrite any previous value(s) of the same component type.
Note
Unlike Self::insert
, this will not panic if the associated entity does not exist.
Example
#[derive(Component)]
struct Health(u32);
#[derive(Component)]
struct Strength(u32);
#[derive(Component)]
struct Defense(u32);
#[derive(Bundle)]
struct CombatBundle {
health: Health,
strength: Strength,
}
fn add_combat_stats_system(mut commands: Commands, player: Res<PlayerEntity>) {
commands.entity(player.entity)
// You can try_insert individual components:
.try_insert(Defense(10))
// You can also insert tuples of components:
.try_insert(CombatBundle {
health: Health(100),
strength: Strength(40),
});
// Suppose this occurs in a parallel adjacent system or process
commands.entity(player.entity)
.despawn();
commands.entity(player.entity)
// This will not panic nor will it add the component
.try_insert(Defense(5));
}
pub fn remove<T>(&mut self) -> &mut EntityCommands<'w, 's, 'a>where
T: Bundle,
pub fn remove<T>(&mut self) -> &mut EntityCommands<'w, 's, 'a>where T: Bundle,
Removes a [Bundle
] of components from the entity.
See EntityWorldMut::remove
for more
details.
Example
#[derive(Component)]
struct Health(u32);
#[derive(Component)]
struct Strength(u32);
#[derive(Component)]
struct Defense(u32);
#[derive(Bundle)]
struct CombatBundle {
health: Health,
strength: Strength,
}
fn remove_combat_stats_system(mut commands: Commands, player: Res<PlayerEntity>) {
commands
.entity(player.entity)
// You can remove individual components:
.remove::<Defense>()
// You can also remove pre-defined Bundles of components:
.remove::<CombatBundle>()
// You can also remove tuples of components and bundles.
// This is equivalent to the calls above:
.remove::<(Defense, CombatBundle)>();
}
pub fn despawn(&mut self)
pub fn despawn(&mut self)
Despawns the entity.
See [World::despawn
] for more details.
Panics
The command will panic when applied if the associated entity does not exist.
Example
fn remove_character_system(
mut commands: Commands,
character_to_remove: Res<CharacterToRemove>
)
{
commands.entity(character_to_remove.entity).despawn();
}
pub fn add<C>(&mut self, command: C) -> &mut EntityCommands<'w, 's, 'a>where
C: EntityCommand,
pub fn add<C>(&mut self, command: C) -> &mut EntityCommands<'w, 's, 'a>where C: EntityCommand,
Pushes an [EntityCommand
] to the queue, which will get executed for the current [Entity
].
Examples
commands
.spawn_empty()
// Closures with this signature implement `EntityCommand`.
.add(|entity: EntityWorldMut| {
println!("Executed an EntityCommand for {:?}", entity.id());
});
pub fn log_components(&mut self)
pub fn log_components(&mut self)
Logs the components of the entity at the info level.
Panics
The command will panic when applied if the associated entity does not exist.
pub fn commands(&mut self) -> &mut Commands<'w, 's>
pub fn commands(&mut self) -> &mut Commands<'w, 's>
Returns the underlying [Commands
].
Trait Implementations§
§impl<'w, 's, 'a> BuildChildren for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> BuildChildren for EntityCommands<'w, 's, 'a>
§fn with_children(
&mut self,
spawn_children: impl FnOnce(&mut ChildBuilder<'_, '_, '_>)
) -> &mut EntityCommands<'w, 's, 'a>
fn with_children( &mut self, spawn_children: impl FnOnce(&mut ChildBuilder<'_, '_, '_>) ) -> &mut EntityCommands<'w, 's, 'a>
ChildBuilder
.§fn push_children(
&mut self,
children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>
fn push_children( &mut self, children: &[Entity] ) -> &mut EntityCommands<'w, 's, 'a>
§fn insert_children(
&mut self,
index: usize,
children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>
fn insert_children( &mut self, index: usize, children: &[Entity] ) -> &mut EntityCommands<'w, 's, 'a>
§fn remove_children(
&mut self,
children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>
fn remove_children( &mut self, children: &[Entity] ) -> &mut EntityCommands<'w, 's, 'a>
§fn add_child(&mut self, child: Entity) -> &mut EntityCommands<'w, 's, 'a>
fn add_child(&mut self, child: Entity) -> &mut EntityCommands<'w, 's, 'a>
§fn clear_children(&mut self) -> &mut EntityCommands<'w, 's, 'a>
fn clear_children(&mut self) -> &mut EntityCommands<'w, 's, 'a>
Children
] component will be removed if it exists, otherwise this does nothing.§fn replace_children(
&mut self,
children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>
fn replace_children( &mut self, children: &[Entity] ) -> &mut EntityCommands<'w, 's, 'a>
§fn set_parent(&mut self, parent: Entity) -> &mut EntityCommands<'w, 's, 'a>
fn set_parent(&mut self, parent: Entity) -> &mut EntityCommands<'w, 's, 'a>
§fn remove_parent(&mut self) -> &mut EntityCommands<'w, 's, 'a>
fn remove_parent(&mut self) -> &mut EntityCommands<'w, 's, 'a>
Parent
] of this entity. Read more§impl<'w, 's, 'a> BuildChildrenTransformExt for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> BuildChildrenTransformExt for EntityCommands<'w, 's, 'a>
§fn remove_parent_in_place(&mut self) -> &mut EntityCommands<'w, 's, 'a>
fn remove_parent_in_place(&mut self) -> &mut EntityCommands<'w, 's, 'a>
GlobalTransform
]
by updating its [Transform
] to be equal to its current [GlobalTransform
]. Read more§fn set_parent_in_place(
&mut self,
parent: Entity
) -> &mut EntityCommands<'w, 's, 'a>
fn set_parent_in_place( &mut self, parent: Entity ) -> &mut EntityCommands<'w, 's, 'a>
GlobalTransform
]
by updating its [Transform
]. Read more§impl<'w, 's, 'a> DespawnRecursiveExt for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> DespawnRecursiveExt for EntityCommands<'w, 's, 'a>
§fn despawn_recursive(self)
fn despawn_recursive(self)
Despawns the provided entity and its children.
§fn despawn_descendants(&mut self) -> &mut EntityCommands<'w, 's, 'a>
fn despawn_descendants(&mut self) -> &mut EntityCommands<'w, 's, 'a>
§impl<'w, 's, 'a> ReflectCommandExt for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> ReflectCommandExt for EntityCommands<'w, 's, 'a>
§fn insert_reflect(
&mut self,
component: Box<dyn Reflect>
) -> &mut EntityCommands<'w, 's, 'a>
fn insert_reflect( &mut self, component: Box<dyn Reflect> ) -> &mut EntityCommands<'w, 's, 'a>
AppTypeRegistry
]. Read more§fn insert_reflect_with_registry<T>(
&mut self,
component: Box<dyn Reflect>
) -> &mut EntityCommands<'w, 's, 'a>where
T: Resource + AsRef<TypeRegistry>,
fn insert_reflect_with_registry<T>( &mut self, component: Box<dyn Reflect> ) -> &mut EntityCommands<'w, 's, 'a>where T: Resource + AsRef<TypeRegistry>,
insert_reflect
, but using the T
resource as type registry instead of
AppTypeRegistry
. Read more§fn remove_reflect(
&mut self,
component_type_path: impl Into<Cow<'static, str>>
) -> &mut EntityCommands<'w, 's, 'a>
fn remove_reflect( &mut self, component_type_path: impl Into<Cow<'static, str>> ) -> &mut EntityCommands<'w, 's, 'a>
AppTypeRegistry
]. Read more§fn remove_reflect_with_registry<T>(
&mut self,
component_type_name: impl Into<Cow<'static, str>>
) -> &mut EntityCommands<'w, 's, 'a>where
T: Resource + AsRef<TypeRegistry>,
fn remove_reflect_with_registry<T>( &mut self, component_type_name: impl Into<Cow<'static, str>> ) -> &mut EntityCommands<'w, 's, 'a>where T: Resource + AsRef<TypeRegistry>,
Auto Trait Implementations§
impl<'w, 's, 'a> RefUnwindSafe for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> Send for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> Sync for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> Unpin for EntityCommands<'w, 's, 'a>
impl<'w, 's, 'a> !UnwindSafe for EntityCommands<'w, 's, 'a>
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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§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>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§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>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§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.§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.