Struct bevy_inspector_egui::world_inspector::InspectableRegistry

pub struct InspectableRegistry { /* private fields */ }

The InspectableRegistry can be used to tell the WorldInspectorPlugin how to display a type.

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

#[derive(Inspectable)]
struct CustomType;

fn main() {
    let mut app = App::new();
    let mut registry = app
        .world
        .get_resource_mut::<InspectableRegistry>()
        .unwrap();
    registry.register::<CustomType>();
}

Implementations

impl InspectableRegistry

pub fn register<T: Inspectable + 'static>(&mut self)

Register type T so that it can be displayed by the WorldInspectorPlugin.

pub fn register_raw<T: 'static, F>(&mut self, f: F) where
    F: Fn(&mut T, &mut Ui, &mut Context<'_>) -> bool + Send + Sync + 'static, 

Registers a type that doesn’t need to implement Inspectable

pub fn with<T: Inspectable + 'static>(self) -> Self

Variant of InspectableRegistry::register which returns self by-value. Allows

App::new()
  .insert_resource(InspectableRegistry::default().with::<MyType>())
  .run();

pub fn try_execute(
    &self,
    value: &mut dyn Any,
    ui: &mut Ui,
    context: &mut Context<'_>
) -> Result<bool, ()>

Try to run the provided inspectable callback and return whether it has changed the value.

Trait Implementations

impl Default for InspectableRegistry

fn default() -> Self

Returns the “default value” for a type.