Component:LocomotionController

CollapseComponent image 

Locomotion Controller component as seen in the Scene Inspector

The LocomotionController component is used on user root slots to allow user inputs to control Locomotion modules and switch between them. It also handles disabling them when they should be restrained.

Fields

Fields Collapse

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
ScalingEnabled	Bool	Whether the user is allowed to scale or not.
SupressSources	list of Component	Sources of Locomotion suppression. This will usually be a AvatarAnchor.
InputSupressSources	list of Component	A list of Components that act as input control supressors.
LocomotionModules	list of ILocomotionModule	A list of locomotions the user can switch between and use.
ActiveModuleIndex	Int	The current locomotion module being used.
FindUserPreferredModule	Bool	Whether to automatically use the user's preferred locomotion in Settings.
_currentGroundCollider	ICollider	the current object that the user is standing on (supporting ground or slope)
_lastGroundCollider	ICollider	The previous collider the user was standing on before they started nocliping or otherwise.
OnInitialized	delegate of identity Action`1<LocomotionController>	A sync delegate to call and pass this locomotion controller as a reference to when this component Initializes.
_parentHierarchy	list of Slot	A list of slots that are parents of this component.
_dummyCharacterController	CharacterController	The character controller to use when there is no locomotion. Is found on User root.

Usage

Used internally by user systems made in a user slot on spawn.