Struct TokioTasksPlugin

pub struct TokioTasksPlugin {
    pub make_runtime: Box<dyn Fn() -> Runtime + Send + Sync + 'static>,
    pub schedule_label: InternedScheduleLabel,
}

The Bevy Plugin which sets up the TokioTasksRuntime Bevy resource and registers the tick_runtime_update exclusive system.

Fields

make_runtime: Box<dyn Fn() -> Runtime + Send + Sync + 'static>

Callback which is used to create a Tokio runtime when the plugin is installed. The default value for this field configures a multi-threaded Runtime with IO and timer functionality enabled if building for non-wasm32 architectures. On wasm32 the current-thread scheduler is used instead.

schedule_label: InternedScheduleLabel

The ScheduleLabel during which the tick_runtime_update function will be executed. The default value for this field is Update.

Trait Implementations

impl Default for TokioTasksPlugin

fn default() -> Self

Configures the plugin to build a new Tokio Runtime with both IO and timer functionality enabled. On the wasm32 architecture, the Runtime will be the current-thread runtime, on all other architectures the Runtime will be the multi-thread runtime.

The default schedule label is Update.

impl Plugin for TokioTasksPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.