Module bones_framework::lib::ecs::entities
source · Expand description
Entity
implementation, storage, and interation.
Structs§
- Holds a list of alive entities.
- Iterator over entities returned by
Entities::iter_with
. - An entity index.
- Iterator over entities using the provided bitset.
- Wrapper for the
Comp
SystemParam
used asQueryItem
to iterate over entities optionally retrieving components fromComponentStore
. Entities iterated over will not be filtered byOptionalQueryItem
. - Wrapper for the
CompMut
SystemParam
used asQueryItem
to iterate over entities optionally and mutably retrieving components fromComponentStore
. Entities iterated over will not be filtered byOptionalQueryItemMut
.
Enums§
- An error that may occur when querying for a single entity. For example, via
Entities::get_single_with
, or more directly withComponentStore::get_single_with_bitset
orComponentStore::get_single_mut_with_bitset
.
Traits§
- A type representing a component-joining entity query.
Functions§
- Helper func to construct a
OptionalQueryItem
wrapping aComp
SystemParam
. Used to iterate over enities optionally retrieving components fromComponentStore
. Entities iterated over will not be filtered by thisQueryItem
. - Helper func to construct a
OptionalQueryItemMut
wrapping aCompMut
SystemParam
. Used to iterate over enities optionally and mutably retrieving components fromComponentStore
. Entities iterated over will not be filtered by thisQueryItem
.