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

EntityAttribute Class

Extends TypedAbstractAttribute
 Modifiers: final
An attribute that stores an Entity reference.
XML Usage Example (Entity references are typically set programmatically rather than through XML default values): 
<component name="Relationship">
  <EntityAttribute name="target" />
</component>

Signature

class EntityAttribute(key: Int, component: ComponentBase, attributeIndex: Int, initialValue: Entity) : TypedAbstractAttribute<Entity>

Constructors

EntityAttribute ( key , component , attributeIndex , initialValue )
Signature 
constructor(key: Int, component: ComponentBase, attributeIndex: Int, initialValue: Entity)
Parameters
key: Int  The integer key for this attribute
component: ComponentBase  The component this attribute belongs to
attributeIndex: Int
initialValue: Entity  The initial value for this attribute
Returns
EntityAttribute

Properties

value : Entity
[Get][Set]
Signature 
var value: Entity
version : ULong
[Get][Set]
Signature 
open override var version: ULong

Methods

checkIfComponentIsOld ()
Signature 
fun checkIfComponentIsOld()
checkIfComponentIsRecycled ()
Signature 
fun checkIfComponentIsRecycled()
get ()
Signature 
open override fun get(): Any
Returns
Any
getValue ( thisRef , property )
Signature 
operator fun getValue(thisRef: Any?, property: KProperty<*>): Entity
Parameters
thisRef: Any?
property: KProperty
Returns
Entity
set ( value )
Signature 
open override fun set(value: Any)
Parameters
value: Any
setValue ( thisRef , property , value )
Signature 
operator fun setValue(thisRef: Any?, property: KProperty<*>, value: Entity)
Parameters
thisRef: Any?
property: KProperty
value: Entity
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta