Photon Quantum 3.0.0

Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Quantum.CharacterController2DConfig Class Reference

The configuration values of the CharacterController2D. Use this to setup the kcc shape size and tune its movement and collision detection. More...

Public Member Functions

override void Loaded (IResourceManager assets, Native.Allocator allocator)
 

Public Attributes

FP Acceleration = 25
 How fast the character controller accelerates. More...
 
Boolean AirControl = true
 Whether the character controller should be controllable while not grounded. More...
 
FP BaseJumpImpulse = 4
 The default jump impulse for the character controller. More...
 
FP Braking = FP._10
 How fast the character controller decelerates. More...
 
FP Extent = FP._0_20
 The extent value used for the character controller. More...
 
FPVector2 Gravity = new FPVector2(FP._0, -FP._10)
 The gravity applied to the character controller. More...
 
LayerMask LayerMask = -1
 Represents a bitmask for determining which layers an object is on or interacts with. More...
 
Int32 MaxContacts = 4
 The maximum number of contacts considered during character controller movement. More...
 
FP MaxPenetration = FP._0_01
 The maximum allowed penetration distance for the character controller. More...
 
FP MaxSlope = 60
 The maximum slope the character controller can walk on. More...
 
FP MaxSlopeSpeed = FP._5
 The maximum speed the character controller can move on a slope. More...
 
FP MaxSpeed = 3
 The maximum speed the character controller can move. More...
 
FPVector2 Offset = default(FPVector2)
 The offset position of the character controller in relation to its transform position. More...
 
FP PenetrationCorrection = FP._0_50
 The amount of correction applied to the penetration of a character controller. More...
 
FP Radius = FP._0_50 + FP._0_20
 The radius of the character controller. More...
 
Boolean UseManifoldNormal = false
 Whether the character controller should use the manifold normal for collision resolution. More...
 

Static Public Attributes

const long DEFAULT_ID = (long)DefaultAssetGuids.CharacterController2DConfig
 Obsolete. Use the default asset that is set inside the SimulationConfig instead. More...
 

Properties

FPVector2 GravityNormalized [get]
 Normalized Gravity, cached when the asset is loaded. More...
 
FP GravityStrength [get]
 Magnitude of the config Gravity, cached when the asset is loaded. More...
 

Detailed Description

The configuration values of the CharacterController2D. Use this to setup the kcc shape size and tune its movement and collision detection.

Member Data Documentation

◆ DEFAULT_ID

const long Quantum.CharacterController2DConfig.DEFAULT_ID = (long)DefaultAssetGuids.CharacterController2DConfig
static

Obsolete. Use the default asset that is set inside the SimulationConfig instead.

◆ Offset

FPVector2 Quantum.CharacterController2DConfig.Offset = default(FPVector2)

The offset position of the character controller in relation to its transform position.

◆ Radius

FP Quantum.CharacterController2DConfig.Radius = FP._0_50 + FP._0_20

The radius of the character controller.

◆ MaxPenetration

FP Quantum.CharacterController2DConfig.MaxPenetration = FP._0_01

The maximum allowed penetration distance for the character controller.

◆ PenetrationCorrection

FP Quantum.CharacterController2DConfig.PenetrationCorrection = FP._0_50

The amount of correction applied to the penetration of a character controller.

◆ Extent

FP Quantum.CharacterController2DConfig.Extent = FP._0_20

The extent value used for the character controller.

◆ MaxContacts

Int32 Quantum.CharacterController2DConfig.MaxContacts = 4

The maximum number of contacts considered during character controller movement.

◆ LayerMask

LayerMask Quantum.CharacterController2DConfig.LayerMask = -1

Represents a bitmask for determining which layers an object is on or interacts with.

◆ UseManifoldNormal

Boolean Quantum.CharacterController2DConfig.UseManifoldNormal = false

Whether the character controller should use the manifold normal for collision resolution.

◆ AirControl

Boolean Quantum.CharacterController2DConfig.AirControl = true

Whether the character controller should be controllable while not grounded.

◆ Acceleration

FP Quantum.CharacterController2DConfig.Acceleration = 25

How fast the character controller accelerates.

◆ Braking

FP Quantum.CharacterController2DConfig.Braking = FP._10

How fast the character controller decelerates.

◆ BaseJumpImpulse

FP Quantum.CharacterController2DConfig.BaseJumpImpulse = 4

The default jump impulse for the character controller.

◆ MaxSpeed

FP Quantum.CharacterController2DConfig.MaxSpeed = 3

The maximum speed the character controller can move.

◆ Gravity

FPVector2 Quantum.CharacterController2DConfig.Gravity = new FPVector2(FP._0, -FP._10)

The gravity applied to the character controller.

◆ MaxSlope

FP Quantum.CharacterController2DConfig.MaxSlope = 60

The maximum slope the character controller can walk on.

◆ MaxSlopeSpeed

FP Quantum.CharacterController2DConfig.MaxSlopeSpeed = FP._5

The maximum speed the character controller can move on a slope.

Property Documentation

◆ GravityStrength

FP Quantum.CharacterController2DConfig.GravityStrength
get

Magnitude of the config Gravity, cached when the asset is loaded.

◆ GravityNormalized

FPVector2 Quantum.CharacterController2DConfig.GravityNormalized
get

Normalized Gravity, cached when the asset is loaded.