Struct Ref

pub struct Ref<'a, C>
where
    C: Component,
{ /* private fields */ }

Available on crate feature ecs only.

The QueryParameter for getting a reference to a Component

Implementations

impl<'a, C> Ref<'a, C>

where C: Component,

pub fn get_modified(&self) -> bool

Returns whether this Component has been modified since the last system has run

Trait Implementations

impl<'a, C> Deref for Ref<'a, C>

where C: Component,

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &<Ref<'a, C> as Deref>::Target

Dereferences the value.

impl<C> QueryParameter for Ref<'_, C>

where C: Component,

type ComponentContainerLock<'a> = Option<MappedRwLockReadGuard<'a, RawRwLock, ComponentContainer<C>>>

The lock returned from QueryParameter::lock

type ComponentContainer<'a> = Option<&'a ComponentContainer<C>>

The component container that is used to get Components from

fn lock<'a>( state: &SystemRunState<'a>, ) -> <Ref<'_, C> as QueryParameter>::ComponentContainerLock<'a>

Locks any needed state, the first step to creating a Query

fn construct<'a>( lock: &'a mut <Ref<'_, C> as QueryParameter>::ComponentContainerLock<'_>, ) -> <Ref<'_, C> as QueryParameter>::ComponentContainer<'a>

Constructs the component container from the locked state, the final state to creating a Query

fn get_component_types() -> impl Iterator<Item = Borrow>

Returns an iterator over all the Component types that will be locked