Struct yaks::SystemContext

pub struct SystemContext<'scope> { /* fields omitted */ }

Thin wrapper over hecs::World, can prepare queries using a QueryMarker.

Instantiating one directly is only useful when calling systems as plain functions, and can be done either by SystemContext::new() or converting a &hecs::World or &mut hecs::World:

fn some_system(_context: SystemContext, _resources: (), _queries: ()) {}

let mut world = hecs::World::new();

some_system(SystemContext::new(&world), (), ());
some_system((&world).into(), (), ());
some_system((&mut world).into(), (), ());

Implementations

impl<'scope> SystemContext<'scope>

pub fn new(world: &'scope World) -> Self

Wraps a &hecs::World. See documentation for SystemContext itself.

pub fn id(&self) -> Option<SystemId>

Returns a debug-printable SystemId if the system is ran in an Executor, with printed number reflecting the order of insertion into the ExecutorBuilder.

pub fn query<Q>(&self, _: QueryMarker<Q>) -> QueryBorrow<Q> where
    Q: Query + Send + Sync, 

Prepares a query using the given QueryMarker; see hecs::World::query().

Example

fn some_system(
    context: SystemContext,
    _resources: (),
    query: QueryMarker<(&mut Pos, &Vel)>
) {
    for (_entity, (pos, vel)) in context.query(query).iter() {
        *pos += *vel;
    }
};

pub fn query_one<Q>(
    &self,
    _: QueryMarker<Q>,
    entity: Entity
) -> Result<QueryOne<Q>, NoSuchEntity> where
    Q: Query + Send + Sync, 

Prepares a query against a single entity using the given QueryMarker; see hecs::World::query_one().

Example

fn some_system(
    context: SystemContext,
    _resources: (),
    query: QueryMarker<(&mut Pos, &Vel)>
) {
    let mut max_velocity = Vel::default();
    let mut max_velocity_entity = None;
    for (entity, (pos, vel)) in context.query(query).iter() {
        *pos += *vel;
        if *vel > max_velocity {
            max_velocity = *vel;
            max_velocity_entity = Some(entity);
        }
    }
    if let Some(entity) = max_velocity_entity {
        let mut query_one = context
            .query_one(query, entity)
            .expect("no such entity");
        let (pos, _vel) = query_one
            .get()
            .expect("some components are missing");
        *pos = Pos::default();
    }
};

Trait Implementations

impl<'scope> From<&'scope World> for SystemContext<'scope>

fn from(world: &'scope World) -> Self

Performs the conversion.

impl<'scope> From<&'scope mut World> for SystemContext<'scope>

fn from(world: &'scope mut World) -> Self

Performs the conversion.