Context

Struct Context 

Source
pub struct Context {
    pub time: Time,
    pub events: Events,
    pub globals: Globals,
    /* private fields */
}
Expand description

Main context passed to all systems

Centralizes engine state

  • time - Frame timing (delta, fps, frame count)
  • events - Event queue for inter-system communication
  • globals - Type-erased resource storage

Access via system parameter:

#[system]
fn my_system(ctx: &mut Context) {
    let delta = ctx.time.delta();

    for event in ctx.events.read::<CollisionEvent>() {
        // handle collision
    }

    let mut world = ctx.world();
    world.spawn().insert(Health(100));
}

Fields§

§time: Time

Frame timing information

§events: Events

Event queue

§globals: Globals

Shared resource storage

Implementations§

Source§

impl Context

Source

pub fn new() -> Context

Creates a new Context with empty state

Source

pub fn quit(&mut self)

Signals the engine to stop after the current frame completes

The main loop will exit gracefully after all systems finish execution.

Source

pub fn is_running(&self) -> bool

Returns true if the engine is still running

Source

pub fn register<G>(&mut self, global: G)
where G: Any + Send + Sync + 'static,

Registers a global resource (shorthand for globals.register())

If a resource of this type already exists, it will be replaced.

Source

pub fn global<G>(&self) -> Option<RefMut<'_, G>>
where G: Any + Send + Sync + 'static,

Gets a reference to a global resource

Source

pub fn on<E>(&mut self, f: impl FnMut(&E, &mut Context))
where E: Event + Clone,

Convenience method for reading events

§Example
ctx.on::<KeyboardInput>(|event, _context| {
    println!("Key: {:?}", event.key);
});
Source

pub fn take<E>(&mut self, f: impl FnMut(E, &mut Context))
where E: Event,

Convenience method for consuming events

§Example
ctx.take::<MouseButtonInput>(|event, _context| {
    handle_click(event.button);
});

Trait Implementations§

Source§

impl ContextEcsExt for Context

Source§

fn world(&self) -> RefMut<'_, World>

Returns a reference to the World

§Panics

Panics with a helpful message if EcsPlugin is not registered

Source§

impl ContextInputExt for Context

Source§

fn input(&self) -> RefMut<'_, Input>

Returns a reference to the Input manager

§Panics

Panics with a helpful message if InputPlugin is not registered

Source§

impl ContextWindowExt for Context

Source§

fn window(&self) -> RefMut<'_, KonWindow>

Source§

impl Default for Context

Source§

fn default() -> Context

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn 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.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more