Class QueryDescription

Namespace

KeenEyes

Assembly

KeenEyes.Core.dll

Describes which components a query includes, requires, and excludes.

public sealed class QueryDescription

Inheritance

object

QueryDescription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllRequired

All components that must be present (Read + Write + With).

public ImmutableArray<Type> AllRequired { get; }

Property Value

ImmutableArray<Type>

HasStringTagFilters

Whether any string tag filters are applied.

public bool HasStringTagFilters { get; }

Property Value

bool

Read

Components that will be read (ref readonly).

public IReadOnlyList<Type> Read { get; }

Property Value

IReadOnlyList<Type>

With

Components that must be present (filter only).

public IReadOnlyList<Type> With { get; }

Property Value

IReadOnlyList<Type>

WithStringTags

String tags that must be present.

public IReadOnlyList<string> WithStringTags { get; }

Property Value

IReadOnlyList<string>

Without

Components that must NOT be present.

public IReadOnlyList<Type> Without { get; }

Property Value

IReadOnlyList<Type>

WithoutStringTags

String tags that must NOT be present.

public IReadOnlyList<string> WithoutStringTags { get; }

Property Value

IReadOnlyList<string>

Write

Components that will be written (ref).

public IReadOnlyList<Type> Write { get; }

Property Value

IReadOnlyList<Type>

Methods

AddRead<T>()

Adds a component type as read access.

public void AddRead<T>() where T : struct, IComponent

Type Parameters

T

The component type.

AddWithStringTag(string)

Adds a string tag filter (must be present).

public void AddWithStringTag(string tag)

Parameters

tag string

The tag that must be present.

AddWith<T>()

Adds a component type as a filter (must be present).

public void AddWith<T>() where T : struct, IComponent

Type Parameters

T

The component type.

AddWithoutStringTag(string)

Adds a string tag exclusion filter (must NOT be present).

public void AddWithoutStringTag(string tag)

Parameters

tag string

The tag that must NOT be present.

AddWithout<T>()

Adds a component type as an exclusion filter (must NOT be present).

public void AddWithout<T>() where T : struct, IComponent

Type Parameters

T

The component type.

AddWrite<T>()

Adds a component type as write access.

public void AddWrite<T>() where T : struct, IComponent

Type Parameters

T

The component type.

Matches(IEnumerable<Type>)

Checks if an entity with the given components matches this query.

public bool Matches(IEnumerable<Type> entityComponents)

Parameters

entityComponents IEnumerable<Type>

Returns

bool