Struct EntityQueryBuilder

Namespace: Unity.Entities

Syntax

public struct EntityQueryBuilder

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

ForEach(EntityQueryBuilder.F_E)

Declaration

public void ForEach(EntityQueryBuilder.F_E action)

Parameters

Type	Name	Description
Unity.Entities.EntityQueryBuilder.F_E	action

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

ToEntityQuery()

Declaration

public EntityQuery ToEntityQuery()

Returns

Type	Description
EntityQuery

ToEntityQueryDesc()

Declaration

public EntityQueryDesc ToEntityQueryDesc()

Returns

Type	Description
EntityQueryDesc

With(EntityQuery)

Declaration

public EntityQueryBuilder With(EntityQuery entityQuery)

Parameters

Type	Name	Description
EntityQuery	entityQuery

Returns

Type	Description
EntityQueryBuilder

With(EntityQueryOptions)

Declaration

public EntityQueryBuilder With(EntityQueryOptions options)

Parameters

Type	Name	Description
EntityQueryOptions	options

Returns

Type	Description
EntityQueryBuilder

WithAll(ComponentType)

Declaration

public EntityQueryBuilder WithAll(ComponentType type0)

Parameters

Type	Name	Description
ComponentType	type0

Returns

Type	Description
EntityQueryBuilder

WithAll(ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAll(ComponentType type0, ComponentType type1)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1

Returns

Type	Description
EntityQueryBuilder

WithAll(ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAll(ComponentType type0, ComponentType type1, ComponentType type2)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2

Returns

Type	Description
EntityQueryBuilder

WithAll(ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAll(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3

Returns

Type	Description
EntityQueryBuilder

WithAll(ComponentType, ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAll(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3, ComponentType type4)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3
ComponentType	type4

Returns

Type	Description
EntityQueryBuilder

WithAll<T0>()

Declaration

public EntityQueryBuilder WithAll<T0>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0

WithAll<T0, T1>()

Declaration

public EntityQueryBuilder WithAll<T0, T1>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1

WithAll<T0, T1, T2>()

Declaration

public EntityQueryBuilder WithAll<T0, T1, T2>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2

WithAll<T0, T1, T2, T3>()

Declaration

public EntityQueryBuilder WithAll<T0, T1, T2, T3>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3

WithAll<T0, T1, T2, T3, T4>()

Declaration

public EntityQueryBuilder WithAll<T0, T1, T2, T3, T4>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3
T4

WithAllReadOnly(ComponentType)

Declaration

public EntityQueryBuilder WithAllReadOnly(ComponentType type0)

Parameters

Type	Name	Description
ComponentType	type0

Returns

Type	Description
EntityQueryBuilder

WithAllReadOnly(ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAllReadOnly(ComponentType type0, ComponentType type1)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1

Returns

Type	Description
EntityQueryBuilder

WithAllReadOnly(ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAllReadOnly(ComponentType type0, ComponentType type1, ComponentType type2)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2

Returns

Type	Description
EntityQueryBuilder

WithAllReadOnly(ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAllReadOnly(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3

Returns

Type	Description
EntityQueryBuilder

WithAllReadOnly(ComponentType, ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAllReadOnly(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3, ComponentType type4)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3
ComponentType	type4

Returns

Type	Description
EntityQueryBuilder

WithAllReadOnly<T0>()

Declaration

public EntityQueryBuilder WithAllReadOnly<T0>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0

WithAllReadOnly<T0, T1>()

Declaration

public EntityQueryBuilder WithAllReadOnly<T0, T1>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1

WithAllReadOnly<T0, T1, T2>()

Declaration

public EntityQueryBuilder WithAllReadOnly<T0, T1, T2>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2

WithAllReadOnly<T0, T1, T2, T3>()

Declaration

public EntityQueryBuilder WithAllReadOnly<T0, T1, T2, T3>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3

WithAllReadOnly<T0, T1, T2, T3, T4>()

Declaration

public EntityQueryBuilder WithAllReadOnly<T0, T1, T2, T3, T4>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3
T4

WithAny(ComponentType)

Declaration

public EntityQueryBuilder WithAny(ComponentType type0)

Parameters

Type	Name	Description
ComponentType	type0

Returns

Type	Description
EntityQueryBuilder

WithAny(ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAny(ComponentType type0, ComponentType type1)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1

Returns

Type	Description
EntityQueryBuilder

WithAny(ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAny(ComponentType type0, ComponentType type1, ComponentType type2)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2

Returns

Type	Description
EntityQueryBuilder

WithAny(ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAny(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3

Returns

Type	Description
EntityQueryBuilder

WithAny(ComponentType, ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAny(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3, ComponentType type4)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3
ComponentType	type4

Returns

Type	Description
EntityQueryBuilder

WithAny<T0>()

Declaration

public EntityQueryBuilder WithAny<T0>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0

WithAny<T0, T1>()

Declaration

public EntityQueryBuilder WithAny<T0, T1>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1

WithAny<T0, T1, T2>()

Declaration

public EntityQueryBuilder WithAny<T0, T1, T2>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2

WithAny<T0, T1, T2, T3>()

Declaration

public EntityQueryBuilder WithAny<T0, T1, T2, T3>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3

WithAny<T0, T1, T2, T3, T4>()

Declaration

public EntityQueryBuilder WithAny<T0, T1, T2, T3, T4>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3
T4

WithAnyReadOnly(ComponentType)

Declaration

public EntityQueryBuilder WithAnyReadOnly(ComponentType type0)

Parameters

Type	Name	Description
ComponentType	type0

Returns

Type	Description
EntityQueryBuilder

WithAnyReadOnly(ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAnyReadOnly(ComponentType type0, ComponentType type1)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1

Returns

Type	Description
EntityQueryBuilder

WithAnyReadOnly(ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAnyReadOnly(ComponentType type0, ComponentType type1, ComponentType type2)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2

Returns

Type	Description
EntityQueryBuilder

WithAnyReadOnly(ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAnyReadOnly(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3

Returns

Type	Description
EntityQueryBuilder

WithAnyReadOnly(ComponentType, ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithAnyReadOnly(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3, ComponentType type4)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3
ComponentType	type4

Returns

Type	Description
EntityQueryBuilder

WithAnyReadOnly<T0>()

Declaration

public EntityQueryBuilder WithAnyReadOnly<T0>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0

WithAnyReadOnly<T0, T1>()

Declaration

public EntityQueryBuilder WithAnyReadOnly<T0, T1>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1

WithAnyReadOnly<T0, T1, T2>()

Declaration

public EntityQueryBuilder WithAnyReadOnly<T0, T1, T2>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2

WithAnyReadOnly<T0, T1, T2, T3>()

Declaration

public EntityQueryBuilder WithAnyReadOnly<T0, T1, T2, T3>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3

WithAnyReadOnly<T0, T1, T2, T3, T4>()

Declaration

public EntityQueryBuilder WithAnyReadOnly<T0, T1, T2, T3, T4>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3
T4

WithIncludeAll()

This sets the options IncludeDisabled and EntityQueryOptions.IncludePrefab so that Entities with Disabled or Prefab components will not be hidden from the query.

Declaration

public EntityQueryBuilder WithIncludeAll()

Returns

Type	Description
EntityQueryBuilder

WithNone(ComponentType)

Declaration

public EntityQueryBuilder WithNone(ComponentType type0)

Parameters

Type	Name	Description
ComponentType	type0

Returns

Type	Description
EntityQueryBuilder

WithNone(ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithNone(ComponentType type0, ComponentType type1)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1

Returns

Type	Description
EntityQueryBuilder

WithNone(ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithNone(ComponentType type0, ComponentType type1, ComponentType type2)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2

Returns

Type	Description
EntityQueryBuilder

WithNone(ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithNone(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3

Returns

Type	Description
EntityQueryBuilder

WithNone(ComponentType, ComponentType, ComponentType, ComponentType, ComponentType)

Declaration

public EntityQueryBuilder WithNone(ComponentType type0, ComponentType type1, ComponentType type2, ComponentType type3, ComponentType type4)

Parameters

Type	Name	Description
ComponentType	type0
ComponentType	type1
ComponentType	type2
ComponentType	type3
ComponentType	type4

Returns

Type	Description
EntityQueryBuilder

WithNone<T0>()

Declaration

public EntityQueryBuilder WithNone<T0>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0

WithNone<T0, T1>()

Declaration

public EntityQueryBuilder WithNone<T0, T1>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1

WithNone<T0, T1, T2>()

Declaration

public EntityQueryBuilder WithNone<T0, T1, T2>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2

WithNone<T0, T1, T2, T3>()

Declaration

public EntityQueryBuilder WithNone<T0, T1, T2, T3>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3

WithNone<T0, T1, T2, T3, T4>()

Declaration

public EntityQueryBuilder WithNone<T0, T1, T2, T3, T4>()

Returns

Type	Description
EntityQueryBuilder

Type Parameters

Name	Description
T0
T1
T2
T3
T4