EntityQueryBuilder.md
March 19, 2022 · View on GitHub
DefaultEcs
DefaultEcs
EntityQueryBuilder Class
Represent an helper object to create rules to retrieve a specific subset of Entity.
public sealed class EntityQueryBuilder
Inheritance System.Object 🡒 EntityQueryBuilder
| Methods | |
|---|---|
| AsEnumerable() | Returns an System.Collections.Generic.IEnumerable<> of Entity with the specified rules. |
| AsMap<TKey>() | Returns an EntityMap<TKey> with the specified rules. |
| AsMap<TKey>(int) | Returns an EntityMap<TKey> with the specified rules. |
| AsMap<TKey>(int, IEqualityComparer<TKey>) | Returns an EntityMap<TKey> with the specified rules. |
| AsMap<TKey>(IEqualityComparer<TKey>) | Returns an EntityMap<TKey> with the specified rules. |
| AsMultiMap<TKey>() | Returns an EntityMultiMap<TKey> with the specified rules. |
| AsMultiMap<TKey>(int) | Returns an EntityMultiMap<TKey> with the specified rules. |
| AsMultiMap<TKey>(int, IEqualityComparer<TKey>) | Returns an EntityMultiMap<TKey> with the specified rules. |
| AsMultiMap<TKey>(IEqualityComparer<TKey>) | Returns an EntityMultiMap<TKey> with the specified rules. |
| AsPredicate() | Returns a System.Predicate<> representing the specified rules. |
| AsSet() | Returns an EntitySet with the specified rules. |
| AsSortedSet<TComponent>() | Returns an EntitySortedSet<TComponent> with the specified rules. |
| AsSortedSet<TComponent>(IComparer<TComponent>) | Returns an EntitySortedSet<TComponent> with the specified rules. |
| Copy() | Copies all the rules of the current EntityQueryBuilder to a new instance. |
| WhenAdded<T>() | Makes a rule to observe Entity when a component of type T is added. |
| WhenAddedEither<T>() | Makes a rule to observe Entity when one component of the either group is added. |
| WhenChanged<T>() | Makes a rule to observe Entity when a component of type T is changed. |
| WhenChangedEither<T>() | Makes a rule to observe Entity when one component of the either group is changed. |
| WhenRemoved<T>() | Makes a rule to observe Entity when a component of type T is removed. |
| WhenRemovedEither<T>() | Makes a rule to observe Entity when one component of the either group is removed. |
| With<T>() | Makes a rule to observe Entity with a component of type T. |
| With<T>(ComponentPredicate<T>) | Makes a rule to observe Entity with a component of type T validating the given ComponentPredicate<T>(T). |
| WithEither<T>() | Makes a rule to obsverve Entity with at least one component of the either group. |
| Without<T>() | Makes a rule to ignore Entity with a component of type T. |
| WithoutEither<T>() | Makes a rule to obsverve Entity without at least one component of the either group. |