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

LocomotionSystem

LocomotionSystem

class LocomotionSystem(val locomotionControls: LocomotionControls = LocomotionControls.Right, val canCallbacksConsumeLeftRightInput: Boolean = true) : SystemBase

Constructors

NameSummary
LocomotionSystem
constructor(locomotionControls: LocomotionControls = LocomotionControls.Right, canCallbacksConsumeLeftRightInput: Boolean = true)

Types

NameSummary
Companion
object Companion

Properties

NameSummary
canCallbacksConsumeLeftRightInput
val canCallbacksConsumeLeftRightInput: Boolean = true
cursor
var cursor: SceneObject?
cursorMesh
var cursorMesh: SceneMesh?
locomoteState
var locomoteState: LocomoteState
locomotionControls
val locomotionControls: LocomotionControls
systemManager
lateinit var systemManager: SystemManager

The system manager that this system is associated with.
warpSound
val warpSound: <Error class: unknown class><SceneAudioAsset>

Functions

NameSummary
areControllersInUse
fun areControllersInUse(): Boolean
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
enableLocomotion
fun enableLocomotion(enabled: Boolean)
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.
getControllerInputResult
fun getControllerInputResult(entity: Entity): Boolean
getDependencies
open override 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.
setControllerInputResult
fun setControllerInputResult(entity: Entity, value: Boolean)

Companion

object Companion
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