Struct bevy_ecs::system::Local

pub struct Local<'s, T: FromWorld + Send + 'static>(/* private fields */);

A system local SystemParam.

A local may only be accessed by the system itself and is therefore not visible to other systems. If two or more systems specify the same local type each will have their own unique local. If multiple SystemParams within the same system each specify the same local type each will get their own distinct data storage.

The supplied lifetime parameter is the SystemParams 's lifetime.

Examples

fn write_to_local(mut local: Local<usize>) {
    *local = 42;
}
fn read_from_local(local: Local<usize>) -> usize {
    *local
}
let mut write_system = IntoSystem::into_system(write_to_local);
let mut read_system = IntoSystem::into_system(read_from_local);
write_system.initialize(world);
read_system.initialize(world);

assert_eq!(read_system.run((), world), 0);
write_system.run((), world);
// Note how the read local is still 0 due to the locals not being shared.
assert_eq!(read_system.run((), world), 0);

N.B. A Locals value cannot be read or written to outside of the containing system. To add configuration to a system, convert a capturing closure into the system instead:

struct Config(u32);
#[derive(Resource)]
struct MyU32Wrapper(u32);
fn reset_to_system(value: Config) -> impl FnMut(ResMut<MyU32Wrapper>) {
    move |mut val| val.0 = value.0
}

// .add_systems(reset_to_system(my_config))

Trait Implementations

impl<'w, T: FromWorld + Send + 'static> BuildableSystemParam for Local<'w, T>

type Builder<'b> = T

A mutable reference to this type will be passed to the builder function

fn build( world: &mut World, _meta: &mut SystemMeta, func: impl FnOnce(&mut Self::Builder<'_>) ) -> Self::State

Constructs SystemParam::State for Self using a given builder function

impl<'s, T: Debug + FromWorld + Send + 'static> Debug for Local<'s, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'s, T: FromWorld + Send + 'static> Deref for Local<'s, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'s, T: FromWorld + Send + 'static> DerefMut for Local<'s, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'_s, T: FromWorld + Send + 'static> ExclusiveSystemParam for Local<'_s, T>

type State = SyncCell<T>

Used to store data which persists across invocations of a system.

type Item<'s> = Local<'s, T>

The item type returned when constructing this system param. See SystemParam::Item.

fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Creates a new instance of this param’s State.

fn get_param<'s>( state: &'s mut Self::State, _system_meta: &SystemMeta ) -> Self::Item<'s>

Creates a parameter to be passed into an ExclusiveSystemParamFunction.

impl<'s, 'a, T: FromWorld + Send + 'static> IntoIterator for &'a Local<'s, T>

where &'a T: IntoIterator,

type Item = <&'a T as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a T as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'s, 'a, T: FromWorld + Send + 'static> IntoIterator for &'a mut Local<'s, T>

where &'a mut T: IntoIterator,

type Item = <&'a mut T as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a mut T as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: FromWorld + Send + 'static> SystemParam for Local<'a, T>

type State = SyncCell<T>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Local<'s, T>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

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.

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.

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

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.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )

Queues any deferred mutations to be applied at the next apply_deferred.

impl<'s, T: FromWorld + Send + 'static> ReadOnlySystemParam for Local<'s, T>