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

AvatarBody

AvatarBody

class AvatarBody(head: Entity = Entity.nullEntity(), leftHand: Entity = Entity.nullEntity(), rightHand: Entity = Entity.nullEntity(), root: Entity = Entity.nullEntity(), isPlayerControlled: Boolean = false) : ComponentBase
AvatarBody is a component that represents the body of an avatar. It contains references to the head, left hand, right hand, and root of the avatar. It also contains a boolean flag to indicate whether the avatar is player controlled.
Parameters
JVM
NameSummary
head
The head Entity of the avatar.
leftHand
The left hand Entity of the avatar.
rightHand
The right hand Entity of the avatar.
root
The root Entity of the avatar.
isPlayerControlled
A boolean flag to indicate whether the avatar is player controlled.

Constructors

NameSummary
AvatarBody
constructor(head: Entity = Entity.nullEntity(), leftHand: Entity = Entity.nullEntity(), rightHand: Entity = Entity.nullEntity(), root: Entity = Entity.nullEntity(), isPlayerControlled: Boolean = false)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
open val cachable: Boolean
entID
var entID: Long
head
var head: Entity
isDirty
var isDirty: Boolean
isPlayerControlled
var isPlayerControlled: Boolean
leftHand
var leftHand: Entity
recycled
var recycled: Boolean
rightHand
var rightHand: Entity
root
var root: Entity
timeStamp
var timeStamp: Long

Functions

NameSummary
companion
open override fun companion(): ComponentCompanion
companionUnsafe
open override fun companionUnsafe(): ComponentCompanion?
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributePrimitive?
fun getComponentDataAttributeType(keyString: String): AttributePrimitive?
getComponentDataKey
fun getComponentDataKey(key: String): Int?
getComponentDataValue
fun getComponentDataValue(key: Int): Any?
fun getComponentDataValue(keyString: String): Any?
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData
fun hasComponentData(key: Int): Boolean
fun hasComponentData(keyString: String): Boolean
read
fun read(e: Entity, cachable: Boolean)
recycle
fun recycle()
reset
open fun reset()
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any): Boolean
fun setComponentDataValue(keyString: String, value: Any): Boolean
setPool
fun setPool(pool: ComponentPool<*>, entID: Long)
toString
open override fun toString(): String
typeID
open override fun typeID(): Int
write
fun write(e: Entity)

Companion

object Companion : ComponentCompanion

Properties

NameSummary
attributeKeys_
val attributeKeys_: IntArray
attributeTypeCounts_
val attributeTypeCounts_: IntArray
attributeTypes_
val attributeTypes_: IntArray
attrMetaData_
val attrMetaData_: Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
createDefaultInstance
open override val createDefaultInstance: () -> AvatarBody
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
headData
val headData: EntityAttributeData
headId
val headId: <Error class: unknown class>
id
open override val id: <Error class: unknown class>
isPlayerControlledData
val isPlayerControlledData: BooleanAttributeData
isPlayerControlledId
val isPlayerControlledId: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
leftHandData
val leftHandData: EntityAttributeData
leftHandId
val leftHandId: <Error class: unknown class>
rightHandData
val rightHandData: EntityAttributeData
rightHandId
val rightHandId: <Error class: unknown class>
rootData
val rootData: EntityAttributeData
rootId
val rootId: <Error class: unknown class>

Functions

NameSummary
attributeKeys
open override fun attributeKeys(): IntArray
attributeMetaData
open override fun attributeMetaData(): Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
attributeTypeCountAvailable
open override fun attributeTypeCountAvailable(): Boolean
attributeTypeCounts
open override fun attributeTypeCounts(): IntArray
attributeTypes
open override fun attributeTypes(): IntArray
dependents
open fun dependents(): IntArray
enumClassesMap
open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>>
keyStringToKeyIntMap
open override fun keyStringToKeyIntMap(keyString: String): Int?
Did you find this page helpful?
Thumbs up icon
Thumbs down icon