Documentation

Unity Engine


Unity Engine


WithPresent

Add required component types to the query, whether the type is enabled or not.
Read time 1 minuteLast updated 2 days ago

Definition

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

WithPresent<T>()

Add required component types to the query, whether the type is enabled or not.
public EntityQueryBuilder WithPresent<T1>()

Returns

Type

Description

EntityQueryBuilderThe builder object that invoked this method.

Remarks

To match the resulting query, an Entity must have all of the query's required component types, whether they are enabled or not. To match required types only if they're enabled, use WithAll@@@@1. To match required types only if they're disabled, use WithDisabled@@@@1.
WithPresent accepts up to seven type arguments. You can add more component types by chaining calls together.
To add component types that are not known at compile time, use EntityQueryBuilder.WithPresent@@<c>1(</c>@@0)
The query will request read-only access to the referenced component(s). To request read/write access, use EntityQueryBuilder.WithPresentRW@@<c>1(</c>@@0)

WithPresent<T>(T)

Add a list of required component types to the query, whether they are enabled or disabled.
public EntityQueryBuilder WithPresent<T>(ref T componentTypes) where T : INativeList<ComponentType>

Parameters

componentTypes

T
A list of component types that implements INativeList@@1. For example, NativeList@@1 or FixedList64Bytes

Returns

Type

Description

EntityQueryBuilderThe builder object that invoked this method.

Remarks

To match the resulting query, an Entity must have all of the query's required component types, regardless of whether they are enabled or disabled.