Struct amethyst::prelude::CallbackQueue

pub struct CallbackQueue { /* fields omitted */ }

A simple Callback queue. Using the Sender you can get using the send_handle method, you can add functions modifying World from an asynchronous context. Those callbacks will be ran sequentially without preserving ordering.

Example

// First, get a `Sender` handle.
let handle = world.read_resource::<CallbackQueue>().send_handle();
// Then, create your asynchronous context (Future, Callback-based library, etc..)
let future = ...;
// Finally, use that handle inside of the asynchronous context to run code that can affect `World`.
future.on_complete(move || {
    handle.send(|mut world| world.create_entity().build()).expect("Failed to add Callback to CallbackQueue.");
});

Implementations

impl CallbackQueue

pub fn new() -> Self

Creates a new CallbackQueue.

pub fn send_handle(&self) -> Sender<Callback>

Creates a new handle that allows sending Callbacks to the CallbackQueue.

Trait Implementations

impl Default for CallbackQueue

fn default() -> Self

Returns the "default value" for a type.