PlayerBehaviourSettings Class Reference

More...

Inheritance diagram for PlayerBehaviourSettings:

Static Public Attributes
const string	AssetPath = SettingsStandardPaths.AssetAppSettings + "/PlayerBehaviourSettings"
	The standard path where this asset should be stored.

Properties
float	InteractionPredictionRange = 10f [get, set]
	Interactables within this distance should be predicted, making them more responsive at the cost of increased CPU load.
float	PCMoveSensitivity = 2f [get, set]
	Sensitivity value for PC Movement using keyboard.
float	PCPanSensitivity = 1f [get, set]
	Sensitivity value for PC panning using keyboard.
float	PCSprintMultiplier = 4f [get, set]
	Multiplier value for when PC player sprinting using Left Shift key.
float	PCMouseSensitivity = 0.1f [get, set]
	Sensitivity value for PC rotation using mouse.
float	PCMouseMaxVerticalDirection = 1f [get, set]
	Max vertical direction on PC when using mouse.
float	PCHeadColliderRadius = 1f [get, set]
	Collider radius for PC Player Head.
bool	UsePCInputForXR = false [get, set]
	If true this lets the VR Head be moved using PC Keyboard and Mouse input.
float	VirtualXRDefaultHeight = 1.7f [get, set]
	Default camera height when using PC Input for XR.
float	VirtualXRMoveSensitivity = 0.05f [get, set]
	Move sensitivity value when using PC Input for XR.
float	VirtualXRLookSensitivity = 0.01f [get, set]
	Look sensitivity value when using PC Input for XR.
float	VirtualXRHandsForwardOffset = 0.5f [get, set]
	How far virtual XR hands should offset ahead of the head.
float	VirtualXRHandsSideOffset = 0.4f [get, set]
	How far virtual XR hands should offset to the sides of the head.
float	VirtualXRHandsDownOffset = 0.2f [get, set]
	How far virtual XR hands should offset downward of the head.
Vector3	VirtualXRHandRotationOffset = new Vector3(-55, 40, 3) [get, set]
	Rotation offset of the virtual XR hands from the forward direction.
string	MockLocalPlayerId = "mock-user" [get, set]
	Mock the local player Id to be shown in PlayerInfo. This is useful for testing with multiple Unity editors.
string	MockLocalPlayerName = "Player" [get, set]
	Mock the local player name to be shown in PlayerInfo.
Properties inherited from IPlayerBehaviourSettings

Detailed Description

Property Documentation

InteractionPredictionRange

float InteractionPredictionRange = 10f

getset

Interactables within this distance should be predicted, making them more responsive at the cost of increased CPU load.

Implements IPlayerBehaviourSettings.

MockLocalPlayerId

string MockLocalPlayerId = "mock-user"

getset

Mock the local player Id to be shown in PlayerInfo. This is useful for testing with multiple Unity editors.

Implements IPlayerBehaviourSettings.

MockLocalPlayerName

string MockLocalPlayerName = "Player"

getset

Mock the local player name to be shown in PlayerInfo.

Implements IPlayerBehaviourSettings.

PCHeadColliderRadius

float PCHeadColliderRadius = 1f

getset

Collider radius for PC Player Head.

Implements IPlayerBehaviourSettings.

PCMouseMaxVerticalDirection

float PCMouseMaxVerticalDirection = 1f

getset

Max vertical direction on PC when using mouse.

Implements IPlayerBehaviourSettings.

PCMouseSensitivity

float PCMouseSensitivity = 0.1f

getset

Sensitivity value for PC rotation using mouse.

Implements IPlayerBehaviourSettings.

PCMoveSensitivity

float PCMoveSensitivity = 2f

getset

Sensitivity value for PC Movement using keyboard.

Implements IPlayerBehaviourSettings.

PCPanSensitivity

float PCPanSensitivity = 1f

getset

Sensitivity value for PC panning using keyboard.

Implements IPlayerBehaviourSettings.

PCSprintMultiplier

float PCSprintMultiplier = 4f

getset

Multiplier value for when PC player sprinting using Left Shift key.

Implements IPlayerBehaviourSettings.

UsePCInputForXR

bool UsePCInputForXR = false

getset

If true this lets the VR Head be moved using PC Keyboard and Mouse input.

Implements IPlayerBehaviourSettings.

VirtualXRDefaultHeight

float VirtualXRDefaultHeight = 1.7f

getset

Default camera height when using PC Input for XR.

Implements IPlayerBehaviourSettings.

VirtualXRHandRotationOffset

Vector3 VirtualXRHandRotationOffset = new Vector3(-55, 40, 3)

getset

Rotation offset of the virtual XR hands from the forward direction.

Implements IPlayerBehaviourSettings.

VirtualXRHandsDownOffset

float VirtualXRHandsDownOffset = 0.2f

getset

How far virtual XR hands should offset downward of the head.

Implements IPlayerBehaviourSettings.

VirtualXRHandsForwardOffset

float VirtualXRHandsForwardOffset = 0.5f

getset

How far virtual XR hands should offset ahead of the head.

Implements IPlayerBehaviourSettings.

VirtualXRHandsSideOffset

float VirtualXRHandsSideOffset = 0.4f

getset

How far virtual XR hands should offset to the sides of the head.

Implements IPlayerBehaviourSettings.

VirtualXRLookSensitivity

float VirtualXRLookSensitivity = 0.01f

getset

Look sensitivity value when using PC Input for XR.

Implements IPlayerBehaviourSettings.

VirtualXRMoveSensitivity

float VirtualXRMoveSensitivity = 0.05f

getset

Move sensitivity value when using PC Input for XR.

Implements IPlayerBehaviourSettings.

---

The documentation for this class was generated from the following file:

• Runtime/Settings/Managed/PlayerBehaviourSettings.cs