Struct bevy_inspector_egui::Context

pub struct Context<'a> {
    pub ui_ctx: Option<&'a CtxRef>,
    pub id: Option<u64>,
    /* private fields */
}

The context passed to Inspectable::ui.

Fields

ui_ctx: Option<&'a CtxRef>

egui ui context

id: Option<u64>

Something to distinguish between siblings.

Implementations

impl<'a> Context<'a>

pub fn world(&self) -> Option<&'a World>

Returns a reference to the world if the context has access to it

pub unsafe fn world_mut(&mut self) -> Option<&'a mut World>

Get a mutable reference to the world if the inspector has access to it.

Safety

Users of this function are only allowed to mutate resources and components, but can’t do any changes that would result in changes of archetypes.

pub fn world_scope(
    &mut self,
    ui: &mut Ui,
    ty: &str,
    f: impl FnOnce(&mut World, &mut Ui, &mut Context<'_>) -> bool
) -> bool

Returns the provided closure with mutable access to the world, and a context that has no access to the world.

Will display an error message if the context doesn’t have world access.

pub unsafe fn world_scope_unchecked(
    &mut self,
    ui: &mut Ui,
    ty: &str,
    f: impl FnOnce(&mut World, &mut Ui, &mut Context<'_>) -> bool
) -> bool

Like Context::world_scope, but the context will have world access as well.

Safety

The function must not use the world in ways that would invalidate archetypes, as types like the InspectorQuery will rely on them being the same before and after calling Inspectable::ui.

pub fn resource_scope<T: Resource, F: FnOnce(&mut Ui, &mut Context<'_>, Mut<'_, T>) -> bool>(
    &mut self,
    ui: &mut Ui,
    ty: &str,
    f: F
) -> bool

Temporarily removes a resource from the world and calls the provided closure with that resource while still having &mut Context available.

Will display an error message if the context doesn’t have world access.

impl<'a> Context<'a>

pub fn new_world_access(
    ui_ctx: Option<&'a CtxRef>,
    world: &'a mut World
) -> Self

Create a new context with access to the world

pub fn new_shared(ui_ctx: Option<&'a CtxRef>) -> Self

Creates a context without access to World

pub fn with_world(&self, world: &'a mut World) -> Self

Same context but with different world

pub fn with_id(&mut self, id: u64) -> Context<'_>

Same context but with a derived id

pub fn id(&self) -> Id

Returns the id if present, otherwise a dummy id.