This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Unity 1.24 Reference Guide

OVRPlayerController Class Reference

Controls the player's movement in virtual reality.

MonoBehaviour inherited by OVRPlayerController.

Data Fields

float	Acceleration ( ) The rate acceleration during movement.
float	Damping ( ) The rate of damping on movement.
float	BackAndSideDampen ( ) The rate of additional damping when moving sideways or backwards.
float	JumpForce ( ) The force applied to the character when jumping.
float	RotationAmount ( ) The rate of rotation when using a gamepad.
float	RotationRatchet ( ) The rate of rotation when using the keyboard.
bool	HmdResetsY ( ) If true, reset the initial yaw of the player controller when the Hmd pose is recentered.
bool	HmdRotatesY ( ) If true, tracking data from a child OVRCameraRig will update the direction of movement.
float	GravityModifier ( ) Modifies the strength of gravity.
bool	useProfileData ( ) If true, each OVRPlayerController will use the player's physical height.

Object Data

CharacterController	Controller ( )
OVRCameraRig	CameraRig ( )

Private Data Fields

float	MoveScale ( )
Vector3	MoveThrottle ( )
float	FallSpeed ( )
OVRPose	InitialPose ( )
float	InitialYRotation ( )
float	MoveScaleMultiplier ( )
float	RotationScaleMultiplier ( )
bool	SkipMouseRotation ( )
bool	HaltUpdateMovement ( )
bool	prevHatLeft ( )
bool	prevHatRight ( )
float	SimulationRate ( )
float	buttonRotation ( )

Private Member Functions

void	Start ( )
void	Awake ( )
void	OnEnable ( )
void	OnDisable ( )
void	Update ( )

Object Data

void	UpdateController ( )

Public Member Functions

void	UpdateMovement ( )
void	UpdateTransform ( OVRCameraRig rig ) Invoked by OVRCameraRig's UpdatedAnchors callback.
bool	Jump ( ) Jump! Must be enabled manually.
void	Stop ( ) Stop this instance.
void	GetMoveScaleMultiplier ( ref float moveScaleMultiplier ) Gets the move scale multiplier.
void	SetMoveScaleMultiplier ( float moveScaleMultiplier ) Sets the move scale multiplier.
void	GetRotationScaleMultiplier ( ref float rotationScaleMultiplier ) Gets the rotation scale multiplier.
void	SetRotationScaleMultiplier ( float rotationScaleMultiplier ) Sets the rotation scale multiplier.
void	GetSkipMouseRotation ( ref bool skipMouseRotation ) Gets the allow mouse rotation.
void	SetSkipMouseRotation ( bool skipMouseRotation ) Sets the allow mouse rotation.
void	GetHaltUpdateMovement ( ref bool haltUpdateMovement ) Gets the halt update movement.
void	SetHaltUpdateMovement ( bool haltUpdateMovement ) Sets the halt update movement.
void	ResetOrientation ( ) Resets the player look rotation when the device orientation is reset.

Field Documentation

float OVRPlayerController.Acceleration ( )

The rate acceleration during movement.

float OVRPlayerController.Damping ( )

The rate of damping on movement.

float OVRPlayerController.BackAndSideDampen ( )

The rate of additional damping when moving sideways or backwards.

float OVRPlayerController.JumpForce ( )

The force applied to the character when jumping.

float OVRPlayerController.RotationAmount ( )

The rate of rotation when using a gamepad.

float OVRPlayerController.RotationRatchet ( )

The rate of rotation when using the keyboard.

bool OVRPlayerController.HmdResetsY ( )

If true, reset the initial yaw of the player controller when the Hmd pose is recentered.

bool OVRPlayerController.HmdRotatesY ( )

If true, tracking data from a child OVRCameraRig will update the direction of movement.

float OVRPlayerController.GravityModifier ( )

Modifies the strength of gravity.

bool OVRPlayerController.useProfileData ( )

If true, each OVRPlayerController will use the player's physical height.

Object Data Documentation

CharacterController OVRPlayerController.Controller ( )

OVRCameraRig OVRPlayerController.CameraRig ( )

Object Data Documentation

float OVRPlayerController.MoveScale ( )

Vector3 OVRPlayerController.MoveThrottle ( )

float OVRPlayerController.FallSpeed ( )

OVRPose OVRPlayerController.InitialPose ( )

float OVRPlayerController.InitialYRotation ( )

float OVRPlayerController.MoveScaleMultiplier ( )

float OVRPlayerController.RotationScaleMultiplier ( )

bool OVRPlayerController.SkipMouseRotation ( )

bool OVRPlayerController.HaltUpdateMovement ( )

bool OVRPlayerController.prevHatLeft ( )

bool OVRPlayerController.prevHatRight ( )

float OVRPlayerController.SimulationRate ( )

float OVRPlayerController.buttonRotation ( )

Object Data Documentation

void OVRPlayerController.Start ( )

void OVRPlayerController.Awake ( )

void OVRPlayerController.OnEnable ( )

void OVRPlayerController.OnDisable ( )

void OVRPlayerController.Update ( )

Object Data Documentation

virtual void OVRPlayerController.UpdateController ( )

Member Function Documentation

virtual void OVRPlayerController.UpdateMovement ( )

void OVRPlayerController.UpdateTransform ( OVRCameraRig rig )

Invoked by OVRCameraRig's UpdatedAnchors callback.

Allows the Hmd rotation to update the facing direction of the player.

bool OVRPlayerController.Jump ( )

Jump! Must be enabled manually.

void OVRPlayerController.Stop ( )

Stop this instance.

void OVRPlayerController.GetMoveScaleMultiplier ( ref float moveScaleMultiplier )

Gets the move scale multiplier.

moveScaleMultiplier Move scale multiplier.

void OVRPlayerController.SetMoveScaleMultiplier ( float moveScaleMultiplier )

Sets the move scale multiplier.

moveScaleMultiplier Move scale multiplier.

void OVRPlayerController.GetRotationScaleMultiplier ( ref float rotationScaleMultiplier )

Gets the rotation scale multiplier.

rotationScaleMultiplier Rotation scale multiplier.

void OVRPlayerController.SetRotationScaleMultiplier ( float rotationScaleMultiplier )

Sets the rotation scale multiplier.

rotationScaleMultiplier Rotation scale multiplier.

void OVRPlayerController.GetSkipMouseRotation ( ref bool skipMouseRotation )

Gets the allow mouse rotation.

skipMouseRotation Allow mouse rotation.

void OVRPlayerController.SetSkipMouseRotation ( bool skipMouseRotation )

Sets the allow mouse rotation.

skipMouseRotation If set to true allow mouse rotation.

void OVRPlayerController.GetHaltUpdateMovement ( ref bool haltUpdateMovement )

Gets the halt update movement.

haltUpdateMovement Halt update movement.

void OVRPlayerController.SetHaltUpdateMovement ( bool haltUpdateMovement )

Sets the halt update movement.

haltUpdateMovement If set to true halt update movement.

void OVRPlayerController.ResetOrientation ( )

Resets the player look rotation when the device orientation is reset.

The documentation for this class was generated from the following file: OVR/Scripts/Util/OVRPlayerController.cs