IReadOnlyAvatar

How much control the player has over the character while in the air. A value of 0 means no control, 1 means full control.

Returns a collection of all materials used on the avatar's body. This can be used to change the appearance of the avatar.

The display name shown in the nametag above the avatar's head.

Multiplier on top of the default gravity settings for the space just for the local avatar while falling. This stacks on top of gravityMultiplier. This is useful for making the avatar fall faster than they jump.

Multiplier on top of the default gravity settings for the space just for the local avatar.

Contribution of how much ground friction to apply to the character. A higher value will give the avatar more grip resulting in higher acceleration. This does not affect the avatar's maximum movement speed. Values should be between 0 and 1.

Whether the avatar body is fully loaded. When users join a space, their avatar body is not immediately loaded. This property will be false until the avatar body is loaded. It's also possible for users to switch their avatars on the fly, so this property may change at any time. Use the onAvatarLoadComplete and onAvatarBeforeUnload event to be notified when the avatar body is loaded or unloaded.

Whether the avatar is currently grounded (the feet are touching the ground)

The height in meters that the avatar can jump

Maximum number of times that the avatar can jump in a row before touching the ground.

Optional nametag bar value shown in the nametag above the avatar's head.

Whether the nametag bar is visible.

An optional subtext shown in the nametag above the avatar's head.

Whether the nametag should be visible to other users.

The current position of the avatar's visual representation in the scene. This is the position of the avatar at the feet.

Is ragdoll physics currently active for the avatar?

The current velocity of the avatar's ragdoll body.

The orientation of the avatar's visual representation in the scene. Currently this is always locked to Y-up.

The running speed of the avatar in meters per second.

When enabled, jump is higher depending on how long jump button is held down. Currently variable jump height may result in a slightly higher jumpHeight

The current velocity of the avatar

Whether the avatar is visible in the scene.

Whether the avatar is visible in the scene to other remote users.

The walking speed of the avatar in meters per second.

Get the transform of a bone in the avatar's body.

Event that triggers when the avatar is about to be unloaded. If the avatar is owned by an actor, this may be because the actor has changed their avatar, or because the actor is leaving or disconnecting. This can be used to "deconstruct" anything that was created in the onAvatarLoadComplete event. isBodyLoaded will be set to false after this event is triggered.

Event that triggers when the avatar has finished loading. isBodyLoaded will be set to true before this event is triggered.

Event that is triggered when the avatar's collider hits another collider.

Event that is triggered when an emote avatar animation is started. Note that this doesn't trigger immediately when PlayEmote is called, but when the animation is loaded (asynchronously) and started.

Event that is triggered when the avatar's grounded state changes (isGrounded)

Event that is triggered when the avatar starts to jump

Event that is triggered when the avatar lands on the ground

Event that triggers when the avatar is respawned. Respawn can happen when:

• A user's avatar enters a space and is spawned for the first time
• An avatar is explicitly respawned with Respawn
• An avatar goes out of bounds

For avatars created explicitly through SpawnAvatar this event will not trigger