Struct bevy_ecs::system::SystemState [−][src]
pub struct SystemState<Param: SystemParam> { /* fields omitted */ }
Expand description
Holds on to persistent state required to drive SystemParam
for a System
.
Implementations
pub fn with_config(
world: &mut World,
config: <Param::Fetch as SystemParamState>::Config
) -> Self
pub fn get<'w, 's>(
&'s mut self,
world: &'w World
) -> <Param::Fetch as SystemParamFetch<'w, 's>>::Item where
Param::Fetch: ReadOnlySystemParamFetch,
pub fn get<'w, 's>(
&'s mut self,
world: &'w World
) -> <Param::Fetch as SystemParamFetch<'w, 's>>::Item where
Param::Fetch: ReadOnlySystemParamFetch,
Retrieve the SystemParam
values. This can only be called when all parameters are read-only.
Retrieve the mutable SystemParam
values.
Applies all state queued up for SystemParam
values. For example, this will apply commands queued up
by a Commands
parameter to the given World
.
This function should be called manually after the values returned by SystemState::get
and SystemState::get_mut
are finished being used.
pub unsafe fn get_unchecked_manual<'w, 's>(
&'s mut self,
world: &'w World
) -> <Param::Fetch as SystemParamFetch<'w, 's>>::Item
pub unsafe fn get_unchecked_manual<'w, 's>(
&'s mut self,
world: &'w World
) -> <Param::Fetch as SystemParamFetch<'w, 's>>::Item
Retrieve the SystemParam
values. This will not update archetypes automatically.
Safety
This call might access any of the input parameters in a way that violates Rust’s mutability rules. Make sure the data
access is safe in the context of global World
access. The passed-in World
must be the World
the SystemState
was
created with.
Auto Trait Implementations
impl<Param> RefUnwindSafe for SystemState<Param> where
<Param as SystemParam>::Fetch: RefUnwindSafe,
impl<Param> Send for SystemState<Param>
impl<Param> Sync for SystemState<Param>
impl<Param> Unpin for SystemState<Param> where
<Param as SystemParam>::Fetch: Unpin,
impl<Param> UnwindSafe for SystemState<Param> where
<Param as SystemParam>::Fetch: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
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 more
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
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
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more