Struct bevy_panic_handler::PanicHandler

pub struct PanicHandler { /* private fields */ }

Bevy plugin that opens a popup window on panic & logs an error

Implementations

impl PanicHandler

pub fn new(panic_handler: impl PanicHandleFn) -> Self

Create a new PanicHandler with a function to call after the popup is closed. If you only want the popup, use PanicHandler::default()

Examples found in repository

examples/closure.rs (lines 9-11)

fn main() {
    // The path we used to run the executable
    let running_name = std::env::args().next().unwrap();

    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(bevy_panic_handler::PanicHandler::new(move |_| {
            println!("Panicked! Arg 1 was: {running_name}");
        }))
        .add_systems(Startup, || {
            panic!("Example Error.\nNewlines AOK. 😃\n{} too.", "fmt strings")
        })
        .run();
}

pub fn default_take_panic() -> Self

Create a new PanicHandler, calling the already existing panic hook after the popup is closed

Examples found in repository

examples/popup.rs (line 6)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(bevy_panic_handler::PanicHandler::default_take_panic())
        .add_systems(Startup, || {
            panic!("Example Error.\nNewlines AOK. 😃\n{} too.", "fmt strings")
        })
        .run();
}

Trait Implementations

impl Default for PanicHandler

fn default() -> PanicHandler

Returns the “default value” for a type.

impl Plugin for PanicHandler

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

Configures the [App] to which this plugin is added.

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

Has the plugin finished it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. 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.