Struct TerminalCtrlCHandlerPlugin

pub struct TerminalCtrlCHandlerPlugin;

Available on non-WebAssembly only.

Gracefully handles Ctrl+C by emitting a AppExit event. This plugin is part of the DefaultPlugins.

fn main() {
    App::new()
        .add_plugins(MinimalPlugins)
        .add_plugins(TerminalCtrlCHandlerPlugin)
        .run();
}

If you want to setup your own Ctrl+C handler, you should call the TerminalCtrlCHandlerPlugin::gracefully_exit function in your handler if you want bevy to gracefully exit.

fn main() {
    // Your own `Ctrl+C` handler
    ctrlc::set_handler(move || {
        // Other clean up code ...

        TerminalCtrlCHandlerPlugin::gracefully_exit();
    });

    App::new()
        .add_plugins(DefaultPlugins)
        .run();
}

Implementations

impl TerminalCtrlCHandlerPlugin

pub fn gracefully_exit()

Sends the AppExit event to all apps using this plugin to make them gracefully exit.

pub fn exit_on_flag(events: EventWriter<'_, AppExit>)

Sends a AppExit event when the user presses Ctrl+C on the terminal.

Trait Implementations

impl Default for TerminalCtrlCHandlerPlugin

fn default() -> TerminalCtrlCHandlerPlugin

Returns the “default value” for a type.

impl Plugin for TerminalCtrlCHandlerPlugin

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.