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

EntityAttribute Class

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(keyString: String, key: Int, component: ComponentBase, initialValue: Entity) : TypedAbstractAttribute<Entity> 

Constructors

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

Properties

value : Entity
[Get][Set]
Signature
var value: Entity

Functions

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
keyName ()
Signature
fun keyName(): String
Returns
String
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
Did you find this page helpful?