Struct bevy_ecs::system::ExclusiveFunctionSystem
source · pub struct ExclusiveFunctionSystem<Marker, F>where
F: ExclusiveSystemParamFunction<Marker>,{ /* private fields */ }
Expand description
A function system that runs with exclusive World
access.
You get this by calling IntoSystem::into_system
on a function that only accepts
ExclusiveSystemParam
s.
ExclusiveFunctionSystem
must be .initialized
before they can be run.
Trait Implementations§
source§impl<Marker, F> System for ExclusiveFunctionSystem<Marker, F>where
Marker: 'static,
F: ExclusiveSystemParamFunction<Marker>,
impl<Marker, F> System for ExclusiveFunctionSystem<Marker, F>where
Marker: 'static,
F: ExclusiveSystemParamFunction<Marker>,
§type In = <F as ExclusiveSystemParamFunction<Marker>>::In
type In = <F as ExclusiveSystemParamFunction<Marker>>::In
The system’s input. See
In
for
FunctionSystem
s.§type Out = <F as ExclusiveSystemParamFunction<Marker>>::Out
type Out = <F as ExclusiveSystemParamFunction<Marker>>::Out
The system’s output.
source§fn component_access(&self) -> &Access<ComponentId>
fn component_access(&self) -> &Access<ComponentId>
Returns the system’s component
Access
.source§fn archetype_component_access(&self) -> &Access<ArchetypeComponentId>
fn archetype_component_access(&self) -> &Access<ArchetypeComponentId>
Returns the system’s archetype component
Access
.source§fn is_exclusive(&self) -> bool
fn is_exclusive(&self) -> bool
Returns true if the system must be run exclusively.
source§fn has_deferred(&self) -> bool
fn has_deferred(&self) -> bool
Returns true if system as deferred buffers
source§unsafe fn run_unsafe(
&mut self,
_input: Self::In,
_world: UnsafeWorldCell<'_>
) -> Self::Out
unsafe fn run_unsafe( &mut self, _input: Self::In, _world: UnsafeWorldCell<'_> ) -> Self::Out
Runs the system with the given input in the world. Unlike
System::run
, this function
can be called in parallel with other systems and may break Rust’s aliasing rules
if used incorrectly, making it unsafe to call. Read moresource§fn run(&mut self, input: Self::In, world: &mut World) -> Self::Out
fn run(&mut self, input: Self::In, world: &mut World) -> Self::Out
Runs the system with the given input in the world. Read more
source§fn apply_deferred(&mut self, _world: &mut World)
fn apply_deferred(&mut self, _world: &mut World)
source§fn queue_deferred(&mut self, _world: DeferredWorld<'_>)
fn queue_deferred(&mut self, _world: DeferredWorld<'_>)
Enqueues any
Deferred
system parameters (or other system buffers)
of this system into the world’s command buffer.source§fn initialize(&mut self, world: &mut World)
fn initialize(&mut self, world: &mut World)
Initialize the system.
source§fn update_archetype_component_access(&mut self, _world: UnsafeWorldCell<'_>)
fn update_archetype_component_access(&mut self, _world: UnsafeWorldCell<'_>)
source§fn check_change_tick(&mut self, change_tick: Tick)
fn check_change_tick(&mut self, change_tick: Tick)
source§fn default_system_sets(&self) -> Vec<InternedSystemSet>
fn default_system_sets(&self) -> Vec<InternedSystemSet>
Returns the system’s default system sets. Read more
source§fn get_last_run(&self) -> Tick
fn get_last_run(&self) -> Tick
Gets the tick indicating the last time this system ran.
source§fn set_last_run(&mut self, last_run: Tick)
fn set_last_run(&mut self, last_run: Tick)
Overwrites the tick indicating the last time this system ran. Read more
Auto Trait Implementations§
impl<Marker, F> Freeze for ExclusiveFunctionSystem<Marker, F>where
F: Freeze,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: Freeze,
impl<Marker, F> RefUnwindSafe for ExclusiveFunctionSystem<Marker, F>where
F: RefUnwindSafe,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: RefUnwindSafe,
impl<Marker, F> Send for ExclusiveFunctionSystem<Marker, F>
impl<Marker, F> Sync for ExclusiveFunctionSystem<Marker, F>
impl<Marker, F> Unpin for ExclusiveFunctionSystem<Marker, F>where
F: Unpin,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: Unpin,
impl<Marker, F> UnwindSafe for ExclusiveFunctionSystem<Marker, F>where
F: UnwindSafe,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: UnwindSafe,
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.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
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<S, M, Out, E, B> IntoObserverSystem<E, B, M, Out> for Swhere
S: IntoSystem<Trigger<'static, E, B>, Out, M> + Send + 'static,
E: 'static,
B: Bundle,
<S as IntoSystem<Trigger<'static, E, B>, Out, M>>::System: ObserverSystem<E, B, Out>,
impl<S, M, Out, E, B> IntoObserverSystem<E, B, M, Out> for Swhere
S: IntoSystem<Trigger<'static, E, B>, Out, M> + Send + 'static,
E: 'static,
B: Bundle,
<S as IntoSystem<Trigger<'static, E, B>, Out, M>>::System: ObserverSystem<E, B, Out>,
§type System = <S as IntoSystem<Trigger<'static, E, B>, Out, M>>::System
type System = <S as IntoSystem<Trigger<'static, E, B>, Out, M>>::System
The type of
System
that this instance converts into.source§fn into_system(this: S) -> <S as IntoObserverSystem<E, B, M, Out>>::System
fn into_system(this: S) -> <S as IntoObserverSystem<E, B, M, Out>>::System
Turns this value into its corresponding
System
.source§impl<T> IntoSystem<<T as System>::In, <T as System>::Out, ()> for Twhere
T: System,
impl<T> IntoSystem<<T as System>::In, <T as System>::Out, ()> for Twhere
T: System,
source§fn into_system(this: T) -> T
fn into_system(this: T) -> T
Turns this value into its corresponding
System
.source§fn pipe<B, Final, MarkerB>(
self,
system: B
) -> PipeSystem<Self::System, B::System>where
B: IntoSystem<Out, Final, MarkerB>,
fn pipe<B, Final, MarkerB>(
self,
system: B
) -> PipeSystem<Self::System, B::System>where
B: IntoSystem<Out, Final, MarkerB>,
source§fn map<T, F>(self, f: F) -> AdapterSystem<F, Self::System>
fn map<T, F>(self, f: F) -> AdapterSystem<F, Self::System>
Pass the output of this system into the passed function
f
, creating a new system that
outputs the value returned from the function. Read moresource§fn system_type_id(&self) -> TypeId
fn system_type_id(&self) -> TypeId
source§impl<Marker, F> IntoSystemConfigs<Marker> for F
impl<Marker, F> IntoSystemConfigs<Marker> for F
source§fn into_configs(self) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>
fn into_configs(self) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>
Convert into a
SystemConfigs
.source§fn in_set(self, set: impl SystemSet) -> SystemConfigs
fn in_set(self, set: impl SystemSet) -> SystemConfigs
Add these systems to the provided
set
.source§fn before<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
fn before<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
source§fn after<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
fn after<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
source§fn before_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
fn before_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
Run before all systems in
set
. Read moresource§fn after_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
fn after_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
Run after all systems in
set
. Read moresource§fn distributive_run_if<M>(
self,
condition: impl Condition<M> + Clone
) -> SystemConfigs
fn distributive_run_if<M>( self, condition: impl Condition<M> + Clone ) -> SystemConfigs
Add a run condition to each contained system. Read more
source§fn run_if<M>(self, condition: impl Condition<M>) -> SystemConfigs
fn run_if<M>(self, condition: impl Condition<M>) -> SystemConfigs
source§fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs
Suppress warnings and errors that would result from these systems having ambiguities
(conflicting access but indeterminate order) with systems in
set
.source§fn ambiguous_with_all(self) -> SystemConfigs
fn ambiguous_with_all(self) -> SystemConfigs
Suppress warnings and errors that would result from these systems having ambiguities
(conflicting access but indeterminate order) with any other system.
source§fn chain(self) -> SystemConfigs
fn chain(self) -> SystemConfigs
Treat this collection as a sequence of systems. Read more
source§fn chain_ignore_deferred(self) -> SystemConfigs
fn chain_ignore_deferred(self) -> SystemConfigs
Treat this collection as a sequence of systems. Read more