Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityQueryBuilder.WithPresent

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public EntityQueryBuilder WithPresent();

Returns

EntityQueryBuilder The builder object that invoked this method.

Description

Add required component types to the query, whether the type is enabled or not.

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 M:Unity.Entities.EntityQueryBuilder.WithAll@@@@1. To match required types only if they're disabled, use M:Unity.Entities.EntityQueryBuilder.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 M:Unity.Entities.EntityQueryBuilder.WithPresent@@@@1(@@@@0@)

The query will request read-only access to the referenced component(s). To request read/write access, use M:Unity.Entities.EntityQueryBuilder.WithPresentRW@@@@1(@@@@0@)


Declaration

public EntityQueryBuilder WithPresent(ref T componentTypes);

Parameters

Parameter Description
componentTypes A list of component types that implements T:Unity.Collections.INativeList@@1. For example, T:Unity.Collections.NativeList@@1 or T:Unity.Collections.FixedList64Bytes`1

Returns

EntityQueryBuilder The builder object that invoked this method.

Description

Add a list of required component types to the query, whether they are enabled or disabled.

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.