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

PlayerBodyAttachmentSystem

PlayerBodyAttachmentSystem

class PlayerBodyAttachmentSystem : SystemBase
This PlayerBodyAttachmentSystem is responsible for setting the local player’s avatar body components based on the local player’s attachments.
This System comes default with Meta Spatial SDK and operates on entities with AvatarAttachment components. It interacts with Controller, AvatarBody, and Transform components to manage the local player’s avatar representation.

Constructors

NameSummary
PlayerBodyAttachmentSystem
constructor()

Properties

NameSummary
systemManager
lateinit var systemManager: SystemManager

The system manager that this system is associated with.

Functions

NameSummary
associateSystemManager
fun associateSystemManager(systemManager: SystemManager)

Associates this system with a system manager, used in the Spatial SDK.
delete
open fun delete(entity: Entity)

System should do any housekeeping based on entity being removed from the scene
destroy
open fun destroy()

System should clean up any and all resources for shutdown
equals
open operator override fun equals(other: Any?): Boolean

Checks if this system is equal to another object.
execute
open override fun execute()

System should perform all the operations based on relevant entities.
getDependencies
open fun getDependencies(): SystemDependencies?

Returns the dependencies of this system.
getScene
fun getScene(): Scene

Returns the scene that this system is associated with.
hashCode
open override fun hashCode(): Int

Returns the hash code of this system.
tryGetLocalPlayerAvatarBody
fun tryGetLocalPlayerAvatarBody(): AvatarBody?

Get the local player’s avatar body, if it exists.
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