Struct bevy_ecs::system::ParallelCommands
source · pub struct ParallelCommands<'w, 's> { /* private fields */ }
Expand description
An alternative to Commands
that can be used in parallel contexts, such as those in Query::par_iter
Note: Because command application order will depend on how many threads are ran, non-commutative commands may result in non-deterministic results.
Example:
fn parallel_command_system(
mut query: Query<(Entity, &Velocity)>,
par_commands: ParallelCommands
) {
query.par_iter().for_each(|(entity, velocity)| {
if velocity.magnitude() > 10.0 {
par_commands.command_scope(|mut commands| {
commands.entity(entity).despawn();
});
}
});
}
Implementations§
source§impl<'w, 's> ParallelCommands<'w, 's>
impl<'w, 's> ParallelCommands<'w, 's>
sourcepub fn command_scope<R>(&self, f: impl FnOnce(Commands<'_, '_>) -> R) -> R
pub fn command_scope<R>(&self, f: impl FnOnce(Commands<'_, '_>) -> R) -> R
Temporarily provides access to the Commands
for the current thread.
For an example, see the type-level documentation for ParallelCommands
.
Trait Implementations§
source§impl SystemParam for ParallelCommands<'_, '_>
impl SystemParam for ParallelCommands<'_, '_>
§type Item<'w, 's> = ParallelCommands<'w, 's>
type Item<'w, 's> = ParallelCommands<'w, 's>
The item type returned when constructing this system param.
The value of this associated type should be
Self
, instantiated with new lifetimes. Read moresource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
Registers any
World
access used by this SystemParam
and creates a new instance of this param’s State
.source§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta
)
unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )
For the specified
Archetype
, registers the components accessed by this SystemParam
(if applicable).a Read moresource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
Applies any deferred mutations stored in this
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
Queues any deferred mutations to be applied at the next
apply_deferred
.source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick
) -> Self::Item<'w, 's>
unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick ) -> Self::Item<'w, 's>
Creates a parameter to be passed into a
SystemParamFunction
. Read moreimpl<'w, 's> ReadOnlySystemParam for ParallelCommands<'w, 's>
Auto Trait Implementations§
impl<'w, 's> Freeze for ParallelCommands<'w, 's>
impl<'w, 's> RefUnwindSafe for ParallelCommands<'w, 's>
impl<'w, 's> Send for ParallelCommands<'w, 's>
impl<'w, 's> Sync for ParallelCommands<'w, 's>
impl<'w, 's> Unpin for ParallelCommands<'w, 's>
impl<'w, 's> !UnwindSafe for ParallelCommands<'w, 's>
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.