Struct bevy_inspector_egui::world_inspector::WorldInspectorPlugin

pub struct WorldInspectorPlugin<F = ()>(_);

Plugin for displaying an inspector window of all entites in the world and their components.

use bevy::prelude::*;
use bevy_inspector_egui::WorldInspectorPlugin;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugin(WorldInspectorPlugin::new())
        .add_startup_system(setup)
        .run();
}

fn setup(mut commands: Commands) {
  // setup your scene
  // adding `Name` components will make the inspector more readable
}

To be able to edit custom components in inspector, they need to be registered first with crate::InspectableRegistry, to do that they need to implement crate::Inspectable.

use bevy::prelude::*;
use bevy_inspector_egui::{Inspectable, InspectableRegistry};

#[derive(Inspectable)]
pub struct MyComponent {
    foo: f32,
    bar: usize
}

pub struct MyPlugin;

impl Plugin for MyPlugin {
    fn build(&self, app: &mut App) {
        let mut registry = app
            .world
            .get_resource_or_insert_with(InspectableRegistry::default);

        registry.register::<MyComponent>();
    }
}

Components can be registered in main function aswell, just use your [bevy::app::App] instance to do so.

Implementations

impl WorldInspectorPlugin

pub fn new() -> Self

Create new WorldInpsectorPlugin

pub fn filter<F>(self) -> WorldInspectorPlugin<F>

Constrain the world inspector to only show entities matching the query filter F

#[derive(Component)]
struct Show;

App::new()
  .add_plugin(WorldInspectorPlugin::new().filter::<With<Show>>())
  .run();

Trait Implementations

impl Default for WorldInspectorPlugin

fn default() -> Self

Returns the “default value” for a type.

impl<F> Plugin for WorldInspectorPlugin<F>where
    F: ReadOnlyWorldQuery + 'static,

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

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

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.