Enum EntityQueryOptions

The bit flags to use for the Options field.

Namespace: Unity.Entities
Syntax
[Flags]
public enum EntityQueryOptions

Fields

Name Description Value
Default

No options specified.


 0
IncludePrefab

The query does not exclude entities with the special Prefab component.


 1
IncludeDisabled

Obsolete. Use IncludeDisabledEntities instead.


 2
IncludeDisabledEntities

The query does not exclude entities with the special Disabled component.


To ignore the state of individual enableable components on an entity, use IgnoreComponentEnabledState.

 2
FilterWriteGroup

The query filters selected entities based on the WriteGroupAttribute settings of the components specified in the query description.


 4
IgnoreComponentEnabledState

The query will match all entities in all the query's matching archetypes, regardless of whether any enableable components on those entities are enabled or disabled.


Specifically:

  • Entities with all required enableable components will be matched, even if the components are disabled.
  • Entities with any optional enableable components will be matched, even if the components are disabled.
  • Entities with any excluded enableable component will be matched, even if the components are enabled.
  • Entities missing a required component will NOT be matched; their archetype is not in the potentially matching set.
  • Entities missing all the optional components will NOT be matched; their archetype is not in the potentially matching set.
 8
IncludeSystems

The query does not exclude the special Unity.Entities.SystemInstance component.


 16
IncludeMetaChunks

The query does not exclude the special ChunkHeader component, used by meta-chunks.


 32