Struct TaskContext

pub struct TaskContext { /* private fields */ }

The context arguments which are available to background tasks spawned onto the TokioTasksRuntime.

Implementations

impl TaskContext

pub fn current_tick(&self) -> usize

Returns the current value of the ticket count from the main thread - how many updates have occurred since the start of the program. Because the tick count is updated from the main thread, the tick count may change any time after this function call returns.

pub async fn sleep_updates(&mut self, updates_to_sleep: usize)

Sleeps the background task until a given number of main thread updates have occurred. If you instead want to sleep for a given length of wall-clock time, call the normal Tokio sleep function.

pub async fn run_on_main_thread<Runnable, Output>( &mut self, runnable: Runnable, ) -> Output

where Runnable: FnOnce(MainThreadContext<'_>) -> Output + Send + 'static, Output: Send + 'static,

Invokes a synchronous callback on the main Bevy thread. The callback will have mutable access to the main Bevy World, allowing it to update any resources or entities that it wants. The callback can report results back to the background thread by returning an output value, which will then be returned from this async function once the callback runs.

Trait Implementations

impl Clone for TaskContext

fn clone(&self) -> TaskContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.