Rust插件库bevy-inspector-egui-derive的使用：Bevy引擎的实时属性检查与调试工具

快速插件使用

WorldInspectorPlugin

显示世界中的实体、资源和资产。

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

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(EguiPlugin::default())
        .add_plugins(WorldInspectorPlugin::new())
        .run();
}

ResourceInspectorPlugin

在窗口中显示单个资源。

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

// `InspectorOptions` 是完全可选的
#[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` 不会初始化资源
        .register_type::<Configuration>() // 需要注册类型才能显示
        .add_plugins(EguiPlugin::default())
        .add_plugins(ResourceInspectorPlugin::<Configuration>::default())
        // 也适用于内置资源，只要它们是 `Reflect`
        .add_plugins(ResourceInspectorPlugin::<Time>::default())
        .run();
}

手动UI

快速插件不允许自定义egui窗口或其内容，但您可以轻松构建自己的UI：

use bevy::prelude::*;
use bevy_egui::EguiPlugin;
use bevy_inspector_egui::prelude::*;
use std::any::TypeId;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(EguiPlugin::default())
        .add_plugins(bevy_inspector_egui::DefaultInspectorConfigPlugin) // 添加默认选项和 `InspectorEguiImpl`s
        .add_systems(EguiPrimaryContextPass, inspector_ui)
        .run();
}

fn inspector_ui(world: &mut World) {
    let Ok(egui_context) = world
        .query_filtered::<&mut EguiContext, With<PrimaryEguiContext>>()
        .get_single(world)
    else {
        return;
    };
    let mut egui_context = egui_context.clone();

    egui::Window::new("UI").show(egui_context.get_mut(), |ui| {
        egui::ScrollArea::vertical().show(ui, |ui| {
            // 等同于 `WorldInspectorPlugin`
            bevy_inspector_egui::bevy_inspector::ui_for_world(world, ui);

            egui::CollapsingHeader::new("Materials").show(ui, |ui| {
                bevy_inspector_egui::bevy_inspector::ui_for_assets::<StandardMaterial>(world, ui);
            });

            ui.heading("Entities");
            bevy_inspector_egui::bevy_inspector::ui_for_world_entities(world, ui);
        });
    });
}

完整示例代码

use bevy::prelude::*;
use bevy_inspector_egui::quick::{WorldInspectorPlugin, ResourceInspectorPlugin};
use bevy_inspector_egui::prelude::*;

// 自定义资源结构体
#[derive(Reflect, Resource, Default, InspectorOptions)]
#[reflect(Resource, InspectorOptions)]
struct GameConfig {
    player_name: String,
    #[inspector(min = 0.0, max = 100.0)]
    difficulty: f32,
    #[inspector(min = 1, max = 10)]
    level: usize,
    is_paused: bool,
}

fn main() {
    App::new()
        // 添加默认插件
        .add_plugins(DefaultPlugins)
        
        // 添加egui插件
        .add_plugins(EguiPlugin::default())
        
        // 初始化我们的自定义资源
        .init_resource::<GameConfig>()
        
        // 注册类型以便显示
        .register_type::<GameConfig>()
        
        // 添加世界检查器插件
        .add_plugins(WorldInspectorPlugin::new())
        
        // 添加资源检查器插件来显示我们的GameConfig
        .add_plugins(ResourceInspectorPlugin::<GameConfig>::default())
        
        // 添加资源检查器插件来显示内置的Time资源
        .add_plugins(ResourceInspectorPlugin::<Time>::default())
        
        // 启动应用
        .run();
}

常见问题解答

Q: 如何更改世界检查器中实体的名称？

A: 您可以插入 Name 组件。

Q: 如果我只想显示单个值而不传入整个 &mut World 怎么办？

A: 您可以使用 reflect_inspector::ui_for_value。注意，像 Handle<StandardMaterial> 这样的东西将无法显示资产的值。

Q: 我可以更改我的类型的显示方式吗？

A: 实现 InspectorPrimitive 并调用 app.register_type_data::<T, InspectorEguiImpl>。

Bevy支持表