QueryGroup class final

One matching archetype inside a Query, and the rows it holds.

Exists so a component can be resolved once per archetype instead of once per entity. entity.get<Mote>() is not a per-entity lookup pretending to be cheap - it genuinely returns the same object every time, because a component describes an archetype's layout and every row shares it. A profile put the repeated resolution (Entity.get, Entity.tryGet, ArchetypeRegistry.byId) at ~7% of the engine's CPU.

Hoisting it by hand is only correct when a query matches exactly one archetype, which is not something a caller can see from the query. This makes the scope explicit: inside a group there is exactly one archetype, so get is both hoistable and obviously correct.

Inheritance

Properties

first → Entity
The first element.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<Entity>
A hand-written walk over this archetype's live rows.
no setteroverride
last → Entity
The last element.
no setterinherited
length → int
The number of elements in this Iterable.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Entity
Checks that this iterable has only one element, and returns that element.
no setterinherited
storage → ArchetypeStorage
The archetype this group iterates.
final

Methods

any(bool test(Entity element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() → Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → Entity
Returns the indexth element.
inherited
every(bool test(Entity element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(Entity element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(Entity element), {Entity orElse()?}) → Entity
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, Entity element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<Entity> other) → Iterable<Entity>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(Entity element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
get<T extends Component>() → T
This archetype's instance of T - the prefab, viewed as one of the components it mixes in.
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(Entity element), {Entity orElse()?}) → Entity
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(Entity e)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(Entity combine(Entity value, Entity element)) → Entity
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(Entity element), {Entity orElse()?}) → Entity
The single element that satisfies test.
inherited
skip(int count) → Iterable<Entity>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(Entity element)) → Iterable<Entity>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<Entity>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(Entity element)) → Iterable<Entity>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<Entity>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<Entity>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
Returns a string representation of (some of) the elements of this.
inherited
tryGet<T extends Component>() → T?
get, or null when this archetype does not have T.
where(bool test(Entity element)) → Iterable<Entity>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<R>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited