API reference
LocomotionEvent Struct
Conceptually comparable to a PointerEvent, LocomotionEvents encapsulate information about locomotion interactions, indicating a player's intent to teleport, rotate, etc.
These events are emitted by ILocomotionEventBroadcasters and processed by ILocomotionEventHandlers; for canonical examples, see TeleportInteractor and PlayerLocomotor, respectively.
Member Enumerations
Enumeration TranslationType
The manner in which the translational part of a LocomotionEvent.Pose should be interpreted.
For example, if the LocomotionEvent.Rotation property of an event is TranslationType.Absolute, the position expressed in the pose should be understood as world space coordinates to which the player is trying to locomote.
None | No description available |
Velocity | No description available |
Absolute | No description available |
AbsoluteEyeLevel | No description available |
Relative | No description available |
Enumeration RotationType
The manner in which the rotational part of a LocomotionEvent.Pose should be interpreted.
For example, if the LocomotionEvent.Rotation property of an event is RotationType.Relative, the rotation expressed in the pose should be understood as an addendum to be applied to the current rotation.
None | No description available |
Velocity | No description available |
Absolute | No description available |
Relative | No description available |
Properties
int Identifier[Get]
The numerical identifier of the emitting interactor, comparable to PointerEvent.Identifier; for more information, see the documentation for IInteractorView.Identifier.
Pose Pose[Get]
The target pose represented by this locomotion event.
Depending on Translation and Rotation, not all of this pose may be applicable for a given event; for example, a LocomotionEvent with a Translation of TranslationType.None only represents a target rotation.
TranslationType Translation[Get]
The manner in which the translation component of the target Pose should be interpreted.
For details, see TranslationType.
RotationType Rotation[Get]
The manner in which the rotation component of the target Pose should be interpreted.
For details, see RotationType.
Member Functions
LocomotionEvent
( int identifier,
Pose pose,
TranslationType translationType,
RotationType rotationType )
Constructor for combined translation-rotation locomotion events, such as teleportation with a turn.
Parameters
identifier
Numerical identifier of the emitting interactor (see IInteractorView.Identifier for details)
pose
The pose the user is intending to locomote toward
translationType
The manner in which the translation portion of the locomotion should be interpreted
rotationType
The manner in which the rotation portion of the locomotion should be interpreted
LocomotionEvent
( int identifier,
Vector3 position,
TranslationType translationType )
Constructor for pure translation locomotion events, such as teleportation.
The Rotation of the constructed event will be RotationType.None.
Parameters
identifier
Numerical identifier of the emitting interactor (see IInteractorView.Identifier for details)
position
The position the user is intending to locomote toward
translationType
The manner in which the requested locomotion should be interpreted
LocomotionEvent
( int identifier,
Quaternion rotation,
RotationType rotationType )
Constructor for pure rotation locomotion events, such as snap turning.
The Translation of the constructed event will be TranslationType.None.
Parameters
identifier
Numerical identifier of the emitting interactor (see IInteractorView.Identifier for details)
rotation
The rotation the user is intending to locomote toward
rotationType
The manner in which the requested rotation should be interpreted
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta