UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FCharacterGroundConstraintSettings Class Reference

#include <CharacterGroundConstraintSettings.h>

Public Member Functions

bool operator== (const FCharacterGroundConstraintSettings &Other) const
 

Public Attributes

FVec3 VerticalAxis = FVec3(0.0, 0.0, 1.0)
 
FReal TargetHeight = 0.0
 World space up direction (default z axis)
 
FReal RadialForceLimit = 1500.0
 Desired distance from the character body to the ground.
 
FReal FrictionForceLimit = 100.0
 How much force the character can apply parallel to the ground plane to reach the target position.
 
FReal TwistTorqueLimit = 1000.0
 How much force the character can apply parallel to the ground plane to reach the target position when standing on an unwalkable incline.
 
FReal SwingTorqueLimit = 5000.0
 How much torque the character can apply about the vertical axis to reach the target facing direction.
 
FReal CosMaxWalkableSlopeAngle = 0.633
 How much torque the character can apply about the other axes to remain upright.
 
FReal DampingFactor = 0.0
 Cosine of the maximum angle in degrees that the character is allowed to walk on.
 
FReal AssumedOnGroundHeight = 2.0
 Applies a damping to the vertical ground constraint making it softer. Units: /T.
 
FReal MotionTargetMassBias = 1.0
 Below this height the character is assumed to be on the ground and can apply force/torque to reach the target position and facing.
 
FReal RadialForceMotionTargetScaling = 1.0
 Scaling factor applied to reduce the mass of the ground body in the linear motion target constraint.
 
FReal MaxCharacterGroundMassRatio = -1.0f
 Scale the radial force to always reach this fraction of the motion target.
 
voidUserData = nullptr
 Maximum ratio for the mass of character mass to ground mass. A negative value indicates no mass conditioning is applied.
 

Member Function Documentation

◆ operator==()

bool Chaos::FCharacterGroundConstraintSettings::operator== ( const FCharacterGroundConstraintSettings Other) const
inline

Member Data Documentation

◆ AssumedOnGroundHeight

FReal Chaos::FCharacterGroundConstraintSettings::AssumedOnGroundHeight = 2.0

Applies a damping to the vertical ground constraint making it softer. Units: /T.

◆ CosMaxWalkableSlopeAngle

FReal Chaos::FCharacterGroundConstraintSettings::CosMaxWalkableSlopeAngle = 0.633

How much torque the character can apply about the other axes to remain upright.

◆ DampingFactor

FReal Chaos::FCharacterGroundConstraintSettings::DampingFactor = 0.0

Cosine of the maximum angle in degrees that the character is allowed to walk on.

◆ FrictionForceLimit

FReal Chaos::FCharacterGroundConstraintSettings::FrictionForceLimit = 100.0

How much force the character can apply parallel to the ground plane to reach the target position.

◆ MaxCharacterGroundMassRatio

FReal Chaos::FCharacterGroundConstraintSettings::MaxCharacterGroundMassRatio = -1.0f

Scale the radial force to always reach this fraction of the motion target.

◆ MotionTargetMassBias

FReal Chaos::FCharacterGroundConstraintSettings::MotionTargetMassBias = 1.0

Below this height the character is assumed to be on the ground and can apply force/torque to reach the target position and facing.

◆ RadialForceLimit

FReal Chaos::FCharacterGroundConstraintSettings::RadialForceLimit = 1500.0

Desired distance from the character body to the ground.

◆ RadialForceMotionTargetScaling

FReal Chaos::FCharacterGroundConstraintSettings::RadialForceMotionTargetScaling = 1.0

Scaling factor applied to reduce the mass of the ground body in the linear motion target constraint.

◆ SwingTorqueLimit

FReal Chaos::FCharacterGroundConstraintSettings::SwingTorqueLimit = 5000.0

How much torque the character can apply about the vertical axis to reach the target facing direction.

◆ TargetHeight

FReal Chaos::FCharacterGroundConstraintSettings::TargetHeight = 0.0

World space up direction (default z axis)

◆ TwistTorqueLimit

FReal Chaos::FCharacterGroundConstraintSettings::TwistTorqueLimit = 1000.0

How much force the character can apply parallel to the ground plane to reach the target position when standing on an unwalkable incline.

◆ UserData

void* Chaos::FCharacterGroundConstraintSettings::UserData = nullptr

Maximum ratio for the mass of character mass to ground mass. A negative value indicates no mass conditioning is applied.

◆ VerticalAxis

FVec3 Chaos::FCharacterGroundConstraintSettings::VerticalAxis = FVec3(0.0, 0.0, 1.0)

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