Module entities

Module entities 

Source
Expand description

Entity implementation, storage, and interation.

Structs§

Entities
Holds a list of alive entities.
EntitiesIterWith
Iterator over entities returned by Entities::iter_with.
Entity
An entity index.
EntityIterator
Iterator over entities using the provided bitset.
OptionalQueryItem
Wrapper for the Comp SystemParam used as QueryItem to iterate over entities optionally retrieving components from ComponentStore. Entities iterated over will not be filtered by OptionalQueryItem.
OptionalQueryItemMut
Wrapper for the CompMut SystemParam used as QueryItem to iterate over entities optionally and mutably retrieving components from ComponentStore. Entities iterated over will not be filtered by OptionalQueryItemMut.

Enums§

QuerySingleError
An error that may occur when querying for a single entity. For example, via Entities::get_single_with, or more directly with ComponentStore::get_single_with_bitset or ComponentStore::get_single_mut_with_bitset.

Traits§

QueryItem
A type representing a component-joining entity query.

Functions§

Optional
Helper func to construct a OptionalQueryItem wrapping a Comp SystemParam. Used to iterate over enities optionally retrieving components from ComponentStore. Entities iterated over will not be filtered by this QueryItem.
OptionalMut
Helper func to construct a OptionalQueryItemMut wrapping a CompMut SystemParam. Used to iterate over enities optionally and mutably retrieving components from ComponentStore. Entities iterated over will not be filtered by this QueryItem.