Struct 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 nametags: Query<'w, 's, AnyOf<(&'static Name, &'static Tags)>>,
}

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

Fields

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

Query used to filter instances of the given Kind T.

hierarchy: HierarchyQuery<'w, 's>

HierarchyQuery used to traverse the object hierarchy.

nametags: Query<'w, 's, AnyOf<(&'static Name, &'static Tags)>>

Query to identify objects by name or tags, mainly used for for hierarchy traversal and searching.

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 contains(&self, entity: Entity) -> bool

Returns true if the given Entity is a valid Object<T>.

pub fn iter_ref<'a>( &'a self, world: &'a World, ) -> impl Iterator<Item = ObjectRef<'w, 's, 'a, T>>

Returns an iterator over all ObjectRef instances of Kind T which match the QueryFilter F.

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

Returns an Object<T> from an Entity, if it matches QueryFilter F.

pub fn get_ref<'a>( &'a self, entity: EntityRef<'a>, ) -> Option<ObjectRef<'w, 's, 'a, T>>

Returns an ObjectRef<T> from an EntityRef, if it matches QueryFilter F.

pub fn get_single(&self) -> Result<Object<'w, 's, '_, T>, QuerySingleError>

Returns an Object<T>, if it exists as a single instance.

pub fn get_single_ref<'a>( &'a self, entity: EntityRef<'a>, ) -> Option<ObjectRef<'w, 's, 'a, T>>

Returns an ObjectRef<T> from an EntityRef, if it exists as a single instance.

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

Return an Object of Kind T from an Instance.

Safety

Assumes instance is a valid Instance of Kind T.

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

Return an Object of Kind T from an Instance.

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) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam

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 ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s mut Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

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, AnyOf<(&'static Name, &'static Tags)>>: ReadOnlySystemParam,