Struct VoxelQuery 

pub struct VoxelQuery<'w, 's, Q, F = ()>
where
    Q: WorldQuery + 'static,
    F: ReadOnlyWorldQuery + 'static,
{ /* private fields */ }

A system parameter designed for quickly querying and reading and writing to voxel worlds and voxel chunks.

Implementations

impl<'w, 's, 'a, Q, F> VoxelQuery<'w, 's, Q, F>

where Q: WorldQuery + 'static, F: ReadOnlyWorldQuery + 'static,

pub fn iter(&'a self) -> impl Iterator<Item = ROQueryItem<'_, Q>> + '_

Creates a readonly iterator over all chunks thaT match the given system query.

pub fn iter_mut(&'a mut self) -> impl Iterator<Item = QueryItem<'_, Q>> + '_

Creates a mutable iterator over all chunks thaT match the given system query.

pub fn get_world( &'a self, world_id: Entity, ) -> Result<VoxelWorldQuery<'w, 's, 'a, Q, F>, VoxelQueryError>

Gets a readonly reference to the voxel world with the given world id. The world may or may not have any chunks in it that match the given system query.

pub fn get_world_mut( &'a mut self, world_id: Entity, ) -> Result<VoxelWorldQueryMut<'w, 's, 'a, Q, F>, VoxelQueryError>

Gets a mutable reference to the voxel world with the given world id. The world may or may not have any chunks in it that match the given system query.

pub fn world_iter( &'a self, ) -> impl Iterator<Item = VoxelWorldQuery<'w, 's, 'a, Q, F>> + '_

Gets a readonly iterator over all voxel worlds.

Note: This also includes worlds that do not contain any valid chunks within the system query.

Trait Implementations

impl<Q, F> SystemParam for VoxelQuery<'_, '_, Q, F>

where Q: WorldQuery + 'static, F: ReadOnlyWorldQuery + 'static,

type State = FetchState<Q, F>

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

type Item<'w, 's> = VoxelQuery<'w, 's, Q, 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, Q, F> ReadOnlySystemParam for VoxelQuery<'w, 's, Q, F>

where Q: WorldQuery + 'static, F: ReadOnlyWorldQuery + 'static, Query<'w, 's, (Entity, &'static ChunkEntityPointers), With<VoxelWorld>>: ReadOnlySystemParam, Query<'w, 's, (&'static VoxelChunk, Q), (With<VoxelChunk>, F)>: ReadOnlySystemParam,