Struct DebugPickingPlugin

pub struct DebugPickingPlugin;

Logs events for debugging

“Normal” events are logged at the debug level. “Noisy” events are logged at the trace level. See Bevy’s LogPlugin and Bevy Cheatbook: Logging, Console Messages for details.

Usually, the default level printed is info, so debug and trace messages will not be displayed even when this plugin is active. You can set RUST_LOG to change this.

You can also change the log filter at runtime in your code. The LogPlugin docs give an example.

Use the DebugPickingMode state resource to control this plugin. Example:

use DebugPickingMode::{Normal, Disabled};
app.insert_resource(DebugPickingMode::Normal)
    .add_systems(
        PreUpdate,
        (|mut mode: ResMut<DebugPickingMode>| {
            *mode = match *mode {
                DebugPickingMode::Disabled => DebugPickingMode::Normal,
                _ => DebugPickingMode::Disabled,
            };
        })
        .distributive_run_if(bevy::input::common_conditions::input_just_pressed(
            KeyCode::F3,
        )),
    )

This sets the starting mode of the plugin to DebugPickingMode::Disabled and binds the F3 key to toggle it.

Trait Implementations

impl Clone for DebugPickingPlugin

fn clone(&self) -> DebugPickingPlugin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugPickingPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DebugPickingPlugin

fn default() -> DebugPickingPlugin

Returns the “default value” for a type.

impl Plugin for DebugPickingPlugin

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.