pub struct WorldInspectorPlugin<F = ()>(_);
Expand description
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.system())
.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
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
Auto Trait Implementations
impl<F> RefUnwindSafe for WorldInspectorPlugin<F>
impl<F> Send for WorldInspectorPlugin<F>
impl<F> Sync for WorldInspectorPlugin<F>
impl<F> Unpin for WorldInspectorPlugin<F>
impl<F> UnwindSafe for WorldInspectorPlugin<F>
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given [World]
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more