Photon Quantum 2.1.1

Public Attributes | List of all members
Quantum.CharacterController2DMovement Struct Reference

Result of a 2D KCC raw movement query. More...

Public Attributes

FPVector2 AvgNormal
 Average normal of all collisions. More...
 
Int32 Contacts
 Total number of collisions found in this execution of the movement query. More...
 
FPVector2 Correction
 Full correction vector to move out of collisions. More...
 
Boolean Grounded
 True if at least one collision (not necessarily closest) qualifies as ground. More...
 
FPVector2 GroundNormal
 Surface normal of the closest collision that qualifies as ground, if any. More...
 
FPVector2 NearestNormal
 Surface normal of the nearest collision. More...
 
FP Penetration
 Magnitude of the penetration over the nearest normal. More...
 
FPVector2 SlopeTangent
 Surface tangent (recommended movement direction) in case of a slope (based on gravity). More...
 
FPVector2 Tangent
 Surface tangent (recommended movement direction) in case there's a desired direction passed. More...
 
CharacterMovementType Type
 Recommended type of movement based on found collisions. More...
 

Detailed Description

Result of a 2D KCC raw movement query.

Member Data Documentation

◆ Type

CharacterMovementType Quantum.CharacterController2DMovement.Type

Recommended type of movement based on found collisions.

◆ NearestNormal

FPVector2 Quantum.CharacterController2DMovement.NearestNormal

Surface normal of the nearest collision.

◆ AvgNormal

FPVector2 Quantum.CharacterController2DMovement.AvgNormal

Average normal of all collisions.

◆ GroundNormal

FPVector2 Quantum.CharacterController2DMovement.GroundNormal

Surface normal of the closest collision that qualifies as ground, if any.

◆ Tangent

FPVector2 Quantum.CharacterController2DMovement.Tangent

Surface tangent (recommended movement direction) in case there's a desired direction passed.

◆ SlopeTangent

FPVector2 Quantum.CharacterController2DMovement.SlopeTangent

Surface tangent (recommended movement direction) in case of a slope (based on gravity).

◆ Correction

FPVector2 Quantum.CharacterController2DMovement.Correction

Full correction vector to move out of collisions.

◆ Penetration

FP Quantum.CharacterController2DMovement.Penetration

Magnitude of the penetration over the nearest normal.

◆ Grounded

Boolean Quantum.CharacterController2DMovement.Grounded

True if at least one collision (not necessarily closest) qualifies as ground.

◆ Contacts

Int32 Quantum.CharacterController2DMovement.Contacts

Total number of collisions found in this execution of the movement query.