Kanda Players 0.7.0
Loading...
Searching...
No Matches
Properties | List of all members
IPlayerBehaviourSettings Interface Reference

Stores app settings about how to players should behave. More...

+ Inheritance diagram for IPlayerBehaviourSettings:

Properties

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

Detailed Description

Stores app settings about how to players should behave.

Property Documentation

◆ InteractionPredictionRange

float InteractionPredictionRange
get

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

Implemented in PlayerBehaviourSettings.

◆ MockLocalPlayerId

string MockLocalPlayerId
get

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

Implemented in PlayerBehaviourSettings.

◆ MockLocalPlayerName

string MockLocalPlayerName
get

Mock the local player name to be shown in PlayerInfo.

Implemented in PlayerBehaviourSettings.

◆ PCHeadColliderRadius

float PCHeadColliderRadius
get

Collider radius for PC Player Head.

Implemented in PlayerBehaviourSettings.

◆ PCMouseMaxVerticalDirection

float PCMouseMaxVerticalDirection
get

Max vertical direction on PC when using mouse.

Implemented in PlayerBehaviourSettings.

◆ PCMouseSensitivity

float PCMouseSensitivity
get

Sensitivity value for PC rotation using mouse.

Implemented in PlayerBehaviourSettings.

◆ PCMoveSensitivity

float PCMoveSensitivity
get

Sensitivity value for PC Movement using keyboard.

Implemented in PlayerBehaviourSettings.

◆ PCPanSensitivity

float PCPanSensitivity
get

Sensitivity value for PC panning using keyboard.

Implemented in PlayerBehaviourSettings.

◆ PCSprintMultiplier

float PCSprintMultiplier
get

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

Implemented in PlayerBehaviourSettings.

◆ UsePCInputForXR

bool UsePCInputForXR
get

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

Implemented in PlayerBehaviourSettings.

◆ VirtualXRDefaultHeight

float VirtualXRDefaultHeight
get

Default camera height when using PC Input for XR.

Implemented in PlayerBehaviourSettings.

◆ VirtualXRHandRotationOffset

Vector3 VirtualXRHandRotationOffset
get

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

Implemented in PlayerBehaviourSettings.

◆ VirtualXRHandsDownOffset

float VirtualXRHandsDownOffset
get

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

Implemented in PlayerBehaviourSettings.

◆ VirtualXRHandsForwardOffset

float VirtualXRHandsForwardOffset
get

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

Implemented in PlayerBehaviourSettings.

◆ VirtualXRHandsSideOffset

float VirtualXRHandsSideOffset
get

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

Implemented in PlayerBehaviourSettings.

◆ VirtualXRLookSensitivity

float VirtualXRLookSensitivity
get

Look sensitivity value when using PC Input for XR.

Implemented in PlayerBehaviourSettings.

◆ VirtualXRMoveSensitivity

float VirtualXRMoveSensitivity
get

Move sensitivity value when using PC Input for XR.

Implemented in PlayerBehaviourSettings.

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