Struct moonshine_object::Objects

pub struct Objects<'w, 's, T = Any, F = ()>
where
    T: Kind,
    F: 'static + QueryFilter,
{
    pub instance: Query<'w, 's, Instance<T>, F>,
    pub hierarchy: HierarchyQuery<'w, 's>,
    pub name: Query<'w, 's, &'static Name>,
}

A SystemParam similar to Query which provides Object<T> access for its items.

Fields

instance: Query<'w, 's, Instance<T>, F>

hierarchy: HierarchyQuery<'w, 's>

name: Query<'w, 's, &'static Name>

Implementations

impl<'w, 's, T, F> Objects<'w, 's, T, F>

where T: Kind, F: 'static + QueryFilter,

pub fn iter(&self) -> impl Iterator<Item = Object<'w, 's, '_, T>>

Iterates over all Objects of Kind T which match the QueryFilter F.

pub fn get( &self, entity: Entity ) -> Result<Object<'w, 's, '_, T>, QueryEntityError>

Gets the Object of Kind T from an Entity, if it matches.

pub fn instance(&self, instance: Instance<T>) -> Object<'w, 's, '_, T>

Gets the Object of Kind T from an Instance.

Safety

Assumes instance is a valid Instance of Kind T.

Trait Implementations

impl<T, F> SystemParam for Objects<'_, '_, T, F>

where T: Kind, F: 'static + QueryFilter,

type State = FetchState<T, F>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Objects<'w, 's, T, F>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, T, F> ReadOnlySystemParam for Objects<'w, 's, T, F>

where T: Kind, F: 'static + QueryFilter, Query<'w, 's, Instance<T>, F>: ReadOnlySystemParam, HierarchyQuery<'w, 's>: ReadOnlySystemParam, Query<'w, 's, &'static Name>: ReadOnlySystemParam,