6273227e09
Resolves #13895 Mostly just involves being more explicit about which parts of the docs belong to a list and which begin a new paragraph. - found a few docs that were malformed because of exactly this, so I fixed that by introducing a paragraph - added indentation to nearly all multiline lists - fixed a few minor typos - added `#[allow(dead_code)]` to types that are needed to test annotations but are never constructed ([here](https://github.com/bevyengine/bevy/pull/13899/files#diff-b02b63604e569c8577c491e7a2030d456886d8f6716eeccd46b11df8aac75dafR1514) and [here](https://github.com/bevyengine/bevy/pull/13899/files#diff-b02b63604e569c8577c491e7a2030d456886d8f6716eeccd46b11df8aac75dafR1523)) - verified that `cargo +beta run -p ci -- lints` passes - verified that `cargo +beta run -p ci -- test` passes
53 lines
1.8 KiB
Rust
53 lines
1.8 KiB
Rust
//! This module provides panic handlers for [Bevy](https://bevyengine.org)
|
|
//! apps, and automatically configures platform specifics (i.e. WASM or Android).
|
|
//!
|
|
//! By default, the [`PanicHandlerPlugin`] from this crate is included in Bevy's `DefaultPlugins`.
|
|
//!
|
|
//! For more fine-tuned control over panic behavior, disable the [`PanicHandlerPlugin`] or
|
|
//! `DefaultPlugins` during app initialization.
|
|
|
|
use crate::App;
|
|
use crate::Plugin;
|
|
|
|
/// Adds sensible panic handlers to Apps. This plugin is part of the `DefaultPlugins`. Adding
|
|
/// this plugin will setup a panic hook appropriate to your target platform:
|
|
/// * On WASM, uses [`console_error_panic_hook`](https://crates.io/crates/console_error_panic_hook), logging
|
|
/// to the browser console.
|
|
/// * Other platforms are currently not setup.
|
|
///
|
|
/// ```no_run
|
|
/// # use bevy_app::{App, NoopPluginGroup as MinimalPlugins, PluginGroup, PanicHandlerPlugin};
|
|
/// fn main() {
|
|
/// App::new()
|
|
/// .add_plugins(MinimalPlugins)
|
|
/// .add_plugins(PanicHandlerPlugin)
|
|
/// .run();
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// If you want to setup your own panic handler, you should disable this
|
|
/// plugin from `DefaultPlugins`:
|
|
/// ```no_run
|
|
/// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, PluginGroup, PanicHandlerPlugin};
|
|
/// fn main() {
|
|
/// App::new()
|
|
/// .add_plugins(DefaultPlugins.build().disable::<PanicHandlerPlugin>())
|
|
/// .run();
|
|
/// }
|
|
/// ```
|
|
#[derive(Default)]
|
|
pub struct PanicHandlerPlugin;
|
|
|
|
impl Plugin for PanicHandlerPlugin {
|
|
fn build(&self, _app: &mut App) {
|
|
#[cfg(target_arch = "wasm32")]
|
|
{
|
|
console_error_panic_hook::set_once();
|
|
}
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
{
|
|
// Use the default target panic hook - Do nothing.
|
|
}
|
|
}
|
|
}
|