Struct SyncedLocalTimeline 

pub struct SyncedLocalTimeline<'w, 's> { /* private fields */ }

Read-only access to the application-global LocalTimeline after it has synchronized.

This parameter combines the canonical simulation clock with its LocalTimelineSync controller. Systems using it are skipped until synchronization is ready, and can read both the current simulation tick and the input delay without fetching the controller separately.

Implementations

impl SyncedLocalTimeline<'_, '_>

pub fn current_tick(&self) -> Tick

Return the canonical simulation tick.

pub fn input_delay(&self) -> u16

Return the number of ticks added when assigning local inputs to the simulation timeline.

Methods from Deref<Target = LocalTimeline>

pub fn tick(&self) -> Tick

Get the current tick

pub fn instant(&self, fixed_time: &Time<Fixed>) -> TickInstant

Return the current fractional simulation instant.

LocalTimeline owns the whole simulation tick while Bevy’s Time<Fixed> owns the fractional progress towards the next fixed update. Constructing the instant on demand avoids maintaining a second, potentially stale clock.

Methods from Deref<Target = u32>

pub const MIN: u32 = 0

pub const MAX: u32

pub const BITS: u32

Trait Implementations

impl Deref for SyncedLocalTimeline<'_, '_>

type Target = LocalTimeline

The resulting type after dereferencing.

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

Dereferences the value.

impl ReadOnlySystemParam for SyncedLocalTimeline<'_, '_>

impl SystemParam for SyncedLocalTimeline<'_, '_>

type State = (<Res<'static, LocalTimeline> as SystemParam>::State, <Res<'static, LocalTimelineSync> as SystemParam>::State)

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

type Item<'world, 'state> = SyncedLocalTimeline<'world, 'state>

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) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam.

unsafe fn get_param<'world, 'state>( state: &'state mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'world>, change_tick: ChangeTick, ) -> Result<Self::Item<'world, 'state>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction.

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 ApplyDeferred.

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

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