Crate bevy_inspector_egui[−][src]

This crate provides the ability to annotate structs with a #[derive(Inspectable)], which opens a debug interface using egui where you can visually edit the values of your struct live.

Your struct will then be available to you as a bevy resource.

Example

use bevy_inspector_egui::Inspectable;

#[derive(Inspectable, Default)]
struct Data {
    should_render: bool,
    text: String,
    #[inspectable(min = 42.0, max = 100.0)]
    size: f32,
}

Add the InspectorPlugin to your App.

use bevy_inspector_egui::InspectorPlugin;

fn main() {
    App::build()
        .add_plugins(DefaultPlugins)
        .add_plugin(InspectorPlugin::<Data>::new())
        .add_system(your_system.system())
        .run();
}

// fn your_system(data: Res<Data>) { /* */ }

The list of built-in attributes is documented here.

World Inspector

If you want to display all world entities you can add the WorldInspectorPlugin:

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

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

You can configure it by inserting the WorldInspectorParams resource.

Re-exports

`pub use bevy_egui;`
`pub use bevy_egui::egui;`

Modules

options	Attributes for the built-in `Inspectable` implementations
reflect	`Inspectable` implementation for foreign types implementing `Reflect`
widgets	Utitly types implementing `Inspectable`

Structs

Context	The context passed to `Inspectable::ui`.
InspectableRegistry	The `InspectableRegistry` can be used to tell the `WorldInspectorPlugin` how to display a type.
InspectorPlugin	Bevy plugin for the inspector. See the crate-level docs for an example on how to use it.
WorldInspectorParams	Resource which controls the way the world inspector is shown.
WorldInspectorPlugin	Plugin for displaying an inspector window of all entites in the world and their components.

Traits

Inspectable

This trait describes how a struct should be displayed. It can be derived for structs and enums, see the crate-level docs for how to do that.

Derive Macros