Controls the player's movement in virtual reality.
Specifically, this class builds on the functionality of Unity's built-in CharacterController type to permit movement paradigms suitable for virtual reality, such as teleportation. These capabilities are leveraged by OVRSceneSampleController to control functionality in the sample.
Fields
float Acceleration[Get]
Controls the rate of acceleration during continuous movement (as opposed to teleportation).
Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully. For more information, see Locomotion Best Practices.
float Damping[Get]
Controls the rate of damping during continuous movement (as opposed to teleportation).
Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
float BackAndSideDampen[Get]
Controls the rate of additional damping when moving sideways or backwards during continuous movement (as opposed to teleportation).
Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
float JumpForce[Get]
Controls the force applied to the character when jumping.
Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
float RotationAmount[Get]
Controls the rate of rotation when continuous-rotating (as opposed to snap-rotating) using a gamepad.
If SnapRotation is enabled, RotationRatchet is used instead.Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
float RotationRatchet[Get]
Controls the rate of rotation when turning using the keyboard.
Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
bool SnapRotation[Get]
Determines whether rotation will be applied in a single large "snap" (snap-rotating) as opposed to more slowly over time (continuous-rotating).
bool RotateAroundGuardianCenter[Get]
[Deprecated] When enabled, snap rotation will happen about the guardian rather than the player/camera viewpoint.
This (legacy) option should be left off except for edge cases that require extreme behavioral backwards compatibility.
int FixedSpeedSteps[Get]
Sets the number of discrete speeds that will be used in continuous motion.
If 0, motion speed is not discretized.Well-tuned movement settings in VR play a significant role in user comfort and should be adjusted carefully.
bool HmdResetsY[Get]
If true, reset the initial yaw of the player controller when the Hmd pose is recentered.
Enabling this feature allows users to change the real-to-virtual spatial correspondence with respect to orientation changing how "north" in the virtual world corresponds with "north" in the real world, for example.
bool HmdRotatesY[Get]
If true, tracking data from a child OVRCameraRig will update the direction of movement.
This capability is sometimes referred to as "head-oriented movement."
float GravityModifier[Get]
Modifies the strength of gravity.
This value does not set gravity, but merely modifies it. The underlying value used for gravity is retrieved from Unity's Physics system.
The CameraHeight is the actual height of the HMD and can be used to adjust the height of the character controller, which will affect the ability of the character to move into areas with a low ceiling.
bool Teleported[Get]
This bool is set to true whenever the player controller has been teleported.
It is reset after every frame. Some systems, such as CharacterCameraConstraint, test this boolean in order to disable logic that moves the character controller immediately following the teleport.
bool EnableLinearMovement[Get]
When true, user input will be applied to linear movement.
Set this to false whenever the player controller needs to ignore input for linear movement.
bool EnableRotation[Get]
When true, user input will be applied to rotation.
Set this to false whenever the player controller needs to ignore input for rotation.
bool RotationEitherThumbstick[Get]
Rotation defaults to secondary thumbstick.
You can allow either here. Note that this won't behave well if EnableLinearMovement is true.
Events
Action< Transform > TransformUpdated
This event is raised after the character controller is moved.
This is used by the OVRAvatarLocomotion script to keep the avatar transform synchronized with the OVRPlayerController.
Action CameraUpdated
This event is raised immediately after the camera transform has been updated, but before movement is updated.
Action PreCharacterMove
This event is raised right before the character controller is actually moved in order to provide other systems the opportunity to move the character controller in response to things other than user input, such as movement of the HMD.
See CharacterCameraConstraint.cs for an example of this.
