Struct bevy_inspector_egui::quick::ResourceInspectorPlugin

pub struct ResourceInspectorPlugin<T> { /* private fields */ }

Plugin displaying an egui window for a single resource. Remember to insert the resource and call App::register_type.

You can use ResourceInspectorPlugin::run_if to control when the window is shown, for example in combination with input_toggle_active.

use bevy::prelude::*;
use bevy_inspector_egui::prelude::*;
use bevy_inspector_egui::quick::ResourceInspectorPlugin;

// `InspectorOptions` are completely optional
#[derive(Reflect, Resource, Default, InspectorOptions)]
#[reflect(Resource, InspectorOptions)]
struct Configuration {
    name: String,
    #[inspector(min = 0.0, max = 1.0)]
    option: f32,
}

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .init_resource::<Configuration>() // `ResourceInspectorPlugin` won't initialize the resource
        .register_type::<Configuration>() // you need to register your type to display it
        .add_plugins(ResourceInspectorPlugin::<Configuration>::default())
        // also works with built-in resources, as long as they implement `Reflect`
        .add_plugins(ResourceInspectorPlugin::<Time>::default())
        .run();
}

Implementations

impl<T> ResourceInspectorPlugin<T>

pub fn new() -> Self

pub fn run_if<M>(self, condition: impl Condition<M>) -> Self

Only show the UI of the specified condition is active

Trait Implementations

impl<T> Default for ResourceInspectorPlugin<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Resource + Reflect> Plugin for ResourceInspectorPlugin<T>

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.