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

Constructors

LocomotionSystem ( locomotionControls , canCallbacksConsumeLeftRightInput ) : LocomotionSystem

Signature

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

Parameters

                
                                    locomotionControls:
                                    
        LocomotionControls

                
                                    canCallbacksConsumeLeftRightInput:
                                    
        Boolean

Returns

LocomotionSystem

Properties

canCallbacksConsumeLeftRightInput : Boolean `[Get]`	Signature val canCallbacksConsumeLeftRightInput: Boolean = true
cursor : SceneObject? `[Get][Set]`	Signature var cursor: SceneObject?
cursorMesh : SceneMesh? `[Get][Set]`	Signature var cursorMesh: SceneMesh?
locomoteState : LocomoteState `[Get][Set]`	Signature var locomoteState: LocomoteState
locomotionControls : LocomotionControls `[Get]`	Signature val locomotionControls: LocomotionControls
systemManager : SystemManager `[Get][Set]`	The system manager that this system is associated with. Signature lateinit var systemManager: SystemManager
warpSound : Lazy<SceneAudioAsset> `[Get]`	Signature val warpSound: Lazy<SceneAudioAsset><SceneAudioAsset>

Functions

areControllersInUse () : Boolean	Signature fun areControllersInUse(): Boolean Returns Boolean
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 SystemBase.delete being removed from the scene Signature open fun delete(entity: Entity) Parameters entity: Entity
destroy ()	System should clean up any and all resources for shutdown Signature open fun destroy()
enableLocomotion ( enabled )	Signature fun enableLocomotion(enabled: Boolean) Parameters enabled: Boolean
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()
getControllerInputResult ( entity ) : Boolean	Signature fun getControllerInputResult(entity: Entity): Boolean Parameters entity: Entity Returns Boolean
getDependencies () : SystemDependencies?	Returns the dependencies of this system. Signature open override fun getDependencies(): SystemDependencies? Returns SystemDependencies? The dependencies of this system, or null if there are no dependencies.
getScene () : Scene	Returns the scene that this system is associated with. Signature fun getScene(): Scene Returns Scene 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.
setControllerInputResult ( entity , value )	Signature fun setControllerInputResult(entity: Entity, value: Boolean) Parameters entity: Entity value: Boolean