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

AvatarSystem Class

Extends SystemBase
 Modifiers: final
This System handles the visibility of the controllers and hands.
This System comes default with Meta Spatial SDK and operates on entities with AvatarAttachment and Controller components. It interacts with Transform, Mesh, Box, CreatorVisibility, and Visible components to manage avatar representation in the scene.

Signature

class AvatarSystem : SystemBase

Constructors

AvatarSystem () : AvatarSystem
Signature 
constructor()
Returns

Properties

systemManager : SystemManager
[Get][Set]
The system manager that this system is associated with.
Signature 
lateinit var systemManager: SystemManager

Functions

associateSystemManager ( systemManager )
Associates this system with a system manager, used in the Spatial SDK.
Signature 
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager
The system manager to associate with.
delete ( entity )
System should do any housekeeping based on AvatarSystem.delete being removed from the scene
Signature 
open override fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
System should clean up any and all resources for shutdown
Signature 
open fun destroy()
equals ( other ) : Boolean
Checks if this system is equal to another object.
Signature 
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?
The object to compare with.
Returns
Boolean
True if this system is equal to the other object, false otherwise.
execute ()
System should perform all the operations based on relevant entities.
Signature 
open override fun execute()
getDependencies () : SystemDependencies?
The system must run after the PlayerBodyAttachmentSystem and before the MeshCreationSystem.
Signature 
open override fun getDependencies(): SystemDependencies?
Returns
getScene () : Scene
Returns the scene that this system is associated with.
Signature 
fun getScene(): Scene
Returns
The scene that this system is associated with.
hashCode () : Int
Returns the hash code of this system.
Signature 
open override fun hashCode(): Int
Returns
Int
The hash code of this system.
setShowControllers ( showControllers )
Set the visibility of the controllers.
Signature 
fun setShowControllers(showControllers: Boolean = true)
Parameters
showControllers: Boolean
Whether to show the controllers.
setShowHands ( showHands )
Set the visibility of the hands. By default, we show the hands wrapping around the controllers. If hands are set as visible while controllers are set as invisible, the hands will mimic natural poses while using the controller.
Signature 
fun setShowHands(showHands: Boolean = true)
Parameters
showHands: Boolean
Whether to show the hands.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta