Documentation

Unity Engine


Unity Engine


GetEntityQuery

Gets the cached query for the specified component types, if one exists; otherwise, creates a new query instance and caches it.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

GetEntityQuery(ComponentType[])

Gets the cached query for the specified component types, if one exists; otherwise, creates a new query instance and caches it.
protected EntityQuery GetEntityQuery(params ComponentType[] componentTypes)

Parameters

componentTypes

An array or comma-separated list of component types.

Returns

Type

Description

EntityQueryThe new or cached query.

GetEntityQuery(NativeArray<ComponentType>)

Gets the cached query for the specified component types, if one exists; otherwise, creates a new query instance and caches it.
protected EntityQuery GetEntityQuery(NativeArray<ComponentType> componentTypes)

Parameters

An array of component types.

Returns

Type

Description

EntityQueryThe new or cached query.

GetEntityQuery(EntityQueryDesc[])

Combines an array of query description objects into a single query.
protected EntityQuery GetEntityQuery(params EntityQueryDesc[] queryDesc)

Parameters

An array of query description objects to be combined to define the query.

Returns

Type

Description

EntityQueryThe new or cached query.

Remarks

This function looks for a cached query matching the combined query descriptions, and returns it if one exists; otherwise, the function creates a new query instance and caches it.

GetEntityQuery(EntityQueryBuilder)

Create an entity query from a query description builder.
public EntityQuery GetEntityQuery(in EntityQueryBuilder builder)

Parameters

The description builder

Returns

Type

Description

EntityQueryThe new or cached query.

Remarks

This function looks for a cached query matching the combined query descriptions, and returns it if one exists; otherwise, the function creates a new query instance and caches it.