Struct bevy_ecs::system::FunctionSystem
source · pub struct FunctionSystem<In, Out, Param, Marker, F>where
Param: SystemParam,{ /* private fields */ }
Expand description
The System
counter part of an ordinary function.
You get this by calling IntoSystem::into_system
on a function that only accepts
SystemParam
s. The output of the system becomes the functions return type, while the input
becomes the functions In
tagged parameter or ()
if no such parameter exists.
FunctionSystem
must be .initialized
before they can be run.
Trait Implementations§
source§impl<In, Out, Param, Marker, F> System for FunctionSystem<In, Out, Param, Marker, F>where
In: 'static,
Out: 'static,
Param: SystemParam + 'static,
Marker: 'static,
F: SystemParamFunction<In, Out, Param, Marker> + Send + Sync + 'static,
impl<In, Out, Param, Marker, F> System for FunctionSystem<In, Out, Param, Marker, F>where
In: 'static,
Out: 'static,
Param: SystemParam + 'static,
Marker: 'static,
F: SystemParamFunction<In, Out, Param, Marker> + Send + Sync + 'static,
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§unsafe fn run_unsafe(&mut self, input: Self::In, world: &World) -> Self::Out
unsafe fn run_unsafe(&mut self, input: Self::In, world: &World) -> Self::Out
Runs the system with the given input in the world. Unlike
System::run
, this function
takes a shared reference to World
and may therefore break Rust’s aliasing rules, making
it unsafe to call. Read moresource§fn get_last_change_tick(&self) -> u32
fn get_last_change_tick(&self) -> u32
Gets the system’s last change tick
source§fn set_last_change_tick(&mut self, last_change_tick: u32)
fn set_last_change_tick(&mut self, last_change_tick: u32)
Sets the system’s last change tick Read more
fn apply_buffers(&mut self, world: &mut World)
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: &World)
fn update_archetype_component_access(&mut self, world: &World)
Update the system’s archetype component
Access
.fn check_change_tick(&mut self, change_tick: u32)
source§fn default_labels(&self) -> Vec<SystemLabelId> ⓘ
fn default_labels(&self) -> Vec<SystemLabelId> ⓘ
The default labels for the system
Auto Trait Implementations§
impl<In, Out, Param, Marker, F> RefUnwindSafe for FunctionSystem<In, Out, Param, Marker, F>where
F: RefUnwindSafe,
<Param as SystemParam>::Fetch: RefUnwindSafe,
impl<In, Out, Param, Marker, F> Send for FunctionSystem<In, Out, Param, Marker, F>where
F: Send,
impl<In, Out, Param, Marker, F> Sync for FunctionSystem<In, Out, Param, Marker, F>where
F: Sync,
impl<In, Out, Param, Marker, F> Unpin for FunctionSystem<In, Out, Param, Marker, F>where
F: Unpin,
<Param as SystemParam>::Fetch: Unpin,
impl<In, Out, Param, Marker, F> UnwindSafe for FunctionSystem<In, Out, Param, Marker, F>where
F: UnwindSafe,
<Param as SystemParam>::Fetch: UnwindSafe,
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read moresource§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§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. Read moresource§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. Read more