API reference
API reference
Select your platform
No SDKs available
No versions available

ByEntityFilterOperation Class

Modifiers: final
A class representing a filter operation for Entity attributes. It is used to build a filter expression by specifying equality operations on Entity attribute values.
This class provides a method for creating filter nodes that represent equality conditions on Entity attributes. These filter nodes can then be combined using logical operators (AND, OR) to create complex filtering conditions.
Example: 
// Find entities where entityVar equals a specific entity
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.entityVarData).isEqualTo(someEntity) }
// Find entities where entityVar is not equal to a specific entity
Query.where { has(TestComponent.id) }
     .filter { not(by(TestComponent.entityVarData).isEqualTo(someEntity)) }

Signature

class ByEntityFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)

Constructors

ByEntityFilterOperation ( attrId , filterBuilder ) : ByEntityFilterOperation
Signature 
constructor(attrId: Int, filterBuilder: FilterBuilder)
Parameters
attrId: Int
The attribute id of the attribute of the filter operation.
filterBuilder: FilterBuilder
The filter builder object used to create the filter node.
Returns

Properties

attrId : Int
[Get]
Signature 
val attrId: Int
filterBuilder : FilterBuilder
[Get]
Signature 
val filterBuilder: FilterBuilder

Functions

isEqualTo ( value ) : ByEntityAttributeFilterNode
Creates a filter node representing an equality condition with the given Entity value.
Signature 
fun isEqualTo(value: Entity): ByEntityAttributeFilterNode
Parameters
value: Entity
The Entity value to compare against.
Returns
A filter node representing the equality condition.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta