Struct ScheduleRunnerPlugin

pub struct ScheduleRunnerPlugin {
    pub run_mode: RunMode,
}

Configures an App to run its Schedule according to a given RunMode.

ScheduleRunnerPlugin is included in the MinimalPlugins plugin group.

ScheduleRunnerPlugin is not included in the DefaultPlugins plugin group which assumes that the Schedule will be executed by other means: typically, the winit event loop (see WinitPlugin) executes the schedule making ScheduleRunnerPlugin unnecessary.

Fields

run_mode: RunMode

Determines whether the Schedule is run once or repeatedly.

Implementations

impl ScheduleRunnerPlugin

pub fn run_once() -> Self

See RunMode::Once.

pub fn run_loop(wait_duration: Duration) -> Self

See RunMode::Loop.

Trait Implementations

impl Default for ScheduleRunnerPlugin

fn default() -> ScheduleRunnerPlugin

Returns the “default value” for a type.

impl Plugin for ScheduleRunnerPlugin

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.