Rust游戏开发插件bevy-inspector-egui的使用，Bevy引擎实时调试与属性检视UI工具

快速插件使用

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::prelude::*;
use bevy_inspector_egui::quick::{WorldInspectorPlugin, ResourceInspectorPlugin};

// 自定义配置资源
#[derive(Reflect, Resource, Default, InspectorOptions)]
#[reflect(Resource, InspectorOptions)]
struct GameConfig {
    player_name: String,
    #[inspector(min = 0.0, max = 100.0)]
    player_health: f32,
    #[inspector(min = 0.0, max = 10.0)]
    game_difficulty: f32,
    enable_sound: bool,
}

// 玩家组件
#[derive(Component, Reflect, Default)]
#[reflect(Component)]
struct Player {
    #[inspector(min = 0.0, max = 100.0)]
    health: f32,
    speed: f32,
    is_alive: bool,
}

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        // 初始化自定义资源
        .init_resource::<GameConfig>()
        // 注册反射类型
        .register_type::<GameConfig>()
        .register_type::<Player>()
        // 添加egui插件
        .add_plugins(bevy_egui::EguiPlugin)
        // 添加世界检查器插件
        .add_plugins(WorldInspectorPlugin::new())
        // 添加资源检查器插件
        .add_plugins(ResourceInspectorPlugin::<GameConfig>::default())
        .add_plugins(ResourceInspectorPlugin::<Time>::default())
        // 启动系统
        .add_systems(Startup, setup)
        .add_systems(Update, player_movement)
        .run();
}

fn setup(mut commands: Commands) {
    // 添加摄像机
    commands.spawn(Camera2dBundle::default());
    
    // 创建玩家实体
    commands.spawn((
        SpriteBundle {
            sprite: Sprite {
                color: Color::rgb(0.25, 0.25, 0.75),
                custom_size: Some(Vec2::new(50.0, 50.0)),
                ..default()
            },
            transform: Transform::from_translation(Vec3::new(0.0, 0.0, 0.0)),
            ..default()
        },
        Player {
            health: 100.0,
            speed: 200.0,
            is_alive: true,
        },
        Name::new("Player"),
    ));
}

fn player_movement(
    time: Res<Time>,
    keyboard_input: Res<Input<KeyCode>>,
    mut query: Query<(&mut Transform, &Player)>,
) {
    for (mut transform, player) in query.iter_mut() {
        if !player.is_alive {
            continue;
        }

        let mut direction = Vec3::ZERO;
        
        if keyboard_input.pressed(KeyCode::W) {
            direction.y += 1.0;
        }
        if keyboard_input.pressed(KeyCode::S) {
            direction.y -= 1.0;
        }
        if keyboard_input.pressed(KeyCode::A) {
            direction.x -= 1.0;
        }
        if keyboard_input.pressed(KeyCode::D) {
            direction.x += 1.0;
        }
        
        if direction.length() > 0.0 {
            direction = direction.normalize();
        }
        
        transform.translation += direction * player.speed * time.delta_seconds();
    }
}