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

EntityQueryBuilder.WithNone

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 WithNone();

Returns

EntityQueryBuilder The builder object that invoked this method.

Description

Add excluded component types to the query.

To match the resulting query, an Entity must not have any of the query's excluded component types.

There are several ways to exclude components from a query: - WithAbsent<T>() matches all entities in chunks that do not have T at all.
- WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
- WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.


WithNone 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.WithNone@@@@1(@@@@0@)

Component types added using WithNone are never written to. If the AccessMode field of the provided component type is ComponentType.AccessMode.ReadWrite, it will be forced to ComponentType.AccessMode.ReadOnly in the final query.


Declaration

public EntityQueryBuilder WithNone(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 excluded component types to the query.

To match the resulting query, an Entity must not have any of the query's excluded component types.

There are several ways to exclude components from a query: - WithAbsent<T>() matches all entities in chunks that do not have T at all.
- WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
- WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.


To add component types that are known at compile time, use M:Unity.Entities.EntityQueryBuilder.WithNone@@@@1

Component types added using WithNone are never written to. If the AccessMode field of the provided component type is ComponentType.AccessMode.ReadWrite, it will be forced to ComponentType.AccessMode.ReadOnly in the final query.