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
| Name | Summary |
|---|---|
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
| Name | Summary |
|---|---|
AvatarBody |
Types
| Name | Summary |
|---|---|
Companion | object Companion : ComponentCompanion |
Properties
| Name | Summary |
|---|---|
cachable | val cachable: Boolean = false |
creationTime | var creationTime: 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 |
Functions
| Name | Summary |
|---|---|
getComponentDataAttributeType | fun getComponentDataAttributeType(key: Int): AttributeType? fun getComponentDataAttributeType(keyString: String): AttributeType? |
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<*>) |
toString | open override fun toString(): String |
typeID | open override fun typeID(): Int |
write | fun write(e: Entity) |
Companion
object Companion : ComponentCompanion
Properties
| Name | Summary |
|---|---|
createDefaultInstance | open override val createDefaultInstance: () -> AvatarBody |
id | open override val id: <Error class: unknown class> |
Functions
| Name | Summary |
|---|---|
dependents | open override fun dependents(): IntArray |
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta