Inheritance diagram for GTA.NaturalMotion.StayUprightHelper:

Public Member Functions
	StayUprightHelper (Ped ped)
	Creates a new Instance of the StayUprightHelper for sending a StayUpright Message to a given Ped. More...

Public Member Functions inherited from GTA.NaturalMotion.CustomHelper
void	Start ()
	Starts this Natural Motion behavior on the Ped that will loop until manually aborted. More...

void	Start (int duration)
	Starts this Natural Motion behavior on the Ped for a specified duration. More...

void	Stop ()
	Stops this Natural Motion behavior on the Ped. More...

void	SetArgument (string argName, bool value)
	Sets a Message argument to a bool value. More...

void	SetArgument (string argName, int value)
	Sets a Message argument to a int value. More...

void	SetArgument (string argName, float value)
	Sets a Message argument to a float value. More...

void	SetArgument (string argName, string value)
	Sets a Message argument to a string value. More...

void	SetArgument (string argName, Vector3 value)
	Sets a Message argument to a Vector3 value. More...

void	ResetArguments ()
	Resets all arguments to their default values. More...

override string	ToString ()
	Returns the internal message name. More...

Properties
bool	UseForces `[set]`
	Enable force based constraint. More...

bool	UseTorques `[set]`
	Enable torque based constraint. More...

bool	LastStandMode `[set]`
	Uses position/orientation control on the spine and drifts in the direction of bullets. This ignores all other stayUpright settings. More...

float	LastStandSinkRate `[set]`
	The sink rate (higher for a faster drop). More...

float	LastStandHorizDamping `[set]`
	Higher values for more damping. More...

float	LastStandMaxTime `[set]`
	Max time allowed in last stand mode. More...

bool	TurnTowardsBullets `[set]`
	Use cheat torques to face the direction of bullets if not facing too far away. More...

bool	VelocityBased `[set]`
	Make strength of constraint function of COM velocity. Uses -1 for forceDamping if the damping is positive. More...

bool	TorqueOnlyInAir `[set]`
	Only apply torque based constraint when airBorne. More...

float	ForceStrength `[set]`
	Strength of constraint. More...

float	ForceDamping `[set]`
	Damping in constraint: -1 makes it scale automagically with forceStrength. Other negative values will scale this automagic damping. More...

float	ForceFeetMult `[set]`
	Multiplier to the force applied to the feet. More...

float	ForceSpine3Share `[set]`
	Share of pelvis force applied to spine3. More...

float	ForceLeanReduction `[set]`
	How much the character lean is taken into account when reducing the force. More...

float	ForceInAirShare `[set]`
	Share of the feet force to the airborne foot. More...

float	ForceMin `[set]`
	When min and max are greater than 0 the constraint strength is determined from character strength, scaled into the range given by min and max. More...

float	ForceMax `[set]`
	See above. More...

float	ForceSaturationVel `[set]`
	When in velocityBased mode, the COM velocity at which constraint reaches maximum strength (forceStrength). More...

float	ForceThresholdVel `[set]`
	When in velocityBased mode, the COM velocity above which constraint starts applying forces. More...

float	TorqueStrength `[set]`
	Strength of torque based constraint. More...

float	TorqueDamping `[set]`
	Damping of torque based constraint. More...

float	TorqueSaturationVel `[set]`
	When in velocityBased mode, the COM velocity at which constraint reaches maximum strength (torqueStrength). More...

float	TorqueThresholdVel `[set]`
	When in velocityBased mode, the COM velocity above which constraint starts applying torques. More...

float	SupportPosition `[set]`
	Distance the foot is behind Com projection that is still considered able to generate the support for the upright constraint. More...

float	NoSupportForceMult `[set]`
	Still apply this fraction of the upright constaint force if the foot is not in a position (defined by supportPosition) to generate the support for the upright constraint. More...

float	StepUpHelp `[set]`
	Strength of cheat force applied upwards to spine3 to help the character up steps/slopes. More...

float	StayUpAcc `[set]`
	How much the cheat force takes into account the acceleration of moving platforms. More...

float	StayUpAccMax `[set]`
	The maximum floorAcceleration (of a moving platform) that the cheat force takes into account. More...

Additional Inherited Members
Protected Member Functions inherited from GTA.NaturalMotion.CustomHelper
	CustomHelper (Ped target, string message)
	Creates a helper class for building Natural Motion messages to send to a given Ped. More...

Constructor & Destructor Documentation

◆ StayUprightHelper()

GTA.NaturalMotion.StayUprightHelper.StayUprightHelper ( Ped ped )

Creates a new Instance of the StayUprightHelper for sending a StayUpright Message to a given Ped.

Parameters

ped	The Ped to send the StayUpright Message to.

Property Documentation

◆ ForceDamping

float GTA.NaturalMotion.StayUprightHelper.ForceDamping

set

Damping in constraint: -1 makes it scale automagically with forceStrength. Other negative values will scale this automagic damping.

Default value = -1.0f. Min value = -1.0f. Max value = 50.0f.

◆ ForceFeetMult

float GTA.NaturalMotion.StayUprightHelper.ForceFeetMult

set

Multiplier to the force applied to the feet.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

◆ ForceInAirShare

float GTA.NaturalMotion.StayUprightHelper.ForceInAirShare

set

Share of the feet force to the airborne foot.

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

◆ ForceLeanReduction

float GTA.NaturalMotion.StayUprightHelper.ForceLeanReduction

set

How much the character lean is taken into account when reducing the force.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

◆ ForceMax

float GTA.NaturalMotion.StayUprightHelper.ForceMax

set

See above.

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

◆ ForceMin

float GTA.NaturalMotion.StayUprightHelper.ForceMin

set

When min and max are greater than 0 the constraint strength is determined from character strength, scaled into the range given by min and max.

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

◆ ForceSaturationVel

float GTA.NaturalMotion.StayUprightHelper.ForceSaturationVel

set

When in velocityBased mode, the COM velocity at which constraint reaches maximum strength (forceStrength).

Default value = 4.0f. Min value = 0.1f. Max value = 10.0f.

◆ ForceSpine3Share

float GTA.NaturalMotion.StayUprightHelper.ForceSpine3Share

set

Share of pelvis force applied to spine3.

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

◆ ForceStrength

float GTA.NaturalMotion.StayUprightHelper.ForceStrength

set

Strength of constraint.

Default value = 3.0f. Min value = 0.0f. Max value = 16.0f.

◆ ForceThresholdVel

float GTA.NaturalMotion.StayUprightHelper.ForceThresholdVel

set

When in velocityBased mode, the COM velocity above which constraint starts applying forces.

Default value = 0.5f. Min value = 0.0f. Max value = 5.0f.

◆ LastStandHorizDamping

float GTA.NaturalMotion.StayUprightHelper.LastStandHorizDamping

set

Higher values for more damping.

Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.

◆ LastStandMaxTime

float GTA.NaturalMotion.StayUprightHelper.LastStandMaxTime

set

Max time allowed in last stand mode.

Default value = 0.4f. Min value = 0.0f. Max value = 5.0f.

◆ LastStandMode

bool GTA.NaturalMotion.StayUprightHelper.LastStandMode

set

Uses position/orientation control on the spine and drifts in the direction of bullets. This ignores all other stayUpright settings.

Default value = False.

◆ LastStandSinkRate

float GTA.NaturalMotion.StayUprightHelper.LastStandSinkRate

set

The sink rate (higher for a faster drop).

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

◆ NoSupportForceMult

float GTA.NaturalMotion.StayUprightHelper.NoSupportForceMult

set

Still apply this fraction of the upright constaint force if the foot is not in a position (defined by supportPosition) to generate the support for the upright constraint.

Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.

◆ StayUpAcc

float GTA.NaturalMotion.StayUprightHelper.StayUpAcc

set

How much the cheat force takes into account the acceleration of moving platforms.

Default value = 0.7f. Min value = 0.0f. Max value = 2.0f.

◆ StayUpAccMax

float GTA.NaturalMotion.StayUprightHelper.StayUpAccMax

set

The maximum floorAcceleration (of a moving platform) that the cheat force takes into account.

Default value = 5.0f. Min value = 0.0f. Max value = 15.0f.

◆ StepUpHelp

float GTA.NaturalMotion.StayUprightHelper.StepUpHelp

set

Strength of cheat force applied upwards to spine3 to help the character up steps/slopes.

Default value = 0.0f. Min value = 0.0f. Max value = 16.0f.

◆ SupportPosition

float GTA.NaturalMotion.StayUprightHelper.SupportPosition

set

Distance the foot is behind Com projection that is still considered able to generate the support for the upright constraint.

Default value = 2.0f. Min value = -2.0f. Max value = 2.0f.

◆ TorqueDamping

float GTA.NaturalMotion.StayUprightHelper.TorqueDamping

set

Damping of torque based constraint.

Default value = 0.5f. Min value = 0.0f. Max value = 16.0f.

◆ TorqueOnlyInAir

bool GTA.NaturalMotion.StayUprightHelper.TorqueOnlyInAir

set

Only apply torque based constraint when airBorne.

Default value = False.

◆ TorqueSaturationVel

float GTA.NaturalMotion.StayUprightHelper.TorqueSaturationVel

set

When in velocityBased mode, the COM velocity at which constraint reaches maximum strength (torqueStrength).

Default value = 4.0f. Min value = 0.1f. Max value = 10.0f.

◆ TorqueStrength

float GTA.NaturalMotion.StayUprightHelper.TorqueStrength

set

Strength of torque based constraint.

Default value = 0.0f. Min value = 0.0f. Max value = 16.0f.

◆ TorqueThresholdVel

float GTA.NaturalMotion.StayUprightHelper.TorqueThresholdVel

set

When in velocityBased mode, the COM velocity above which constraint starts applying torques.

Default value = 2.5f. Min value = 0.0f. Max value = 5.0f.

◆ TurnTowardsBullets

bool GTA.NaturalMotion.StayUprightHelper.TurnTowardsBullets

set

Use cheat torques to face the direction of bullets if not facing too far away.

Default value = False.

◆ UseForces

bool GTA.NaturalMotion.StayUprightHelper.UseForces

set

Enable force based constraint.

Default value = False.

◆ UseTorques

bool GTA.NaturalMotion.StayUprightHelper.UseTorques

set

Enable torque based constraint.

Default value = False.

◆ VelocityBased

bool GTA.NaturalMotion.StayUprightHelper.VelocityBased

set

Make strength of constraint function of COM velocity. Uses -1 for forceDamping if the damping is positive.

Default value = False.

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

C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs

Public Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ StayUprightHelper()

Property Documentation

◆ ForceDamping

◆ ForceFeetMult

◆ ForceInAirShare

◆ ForceLeanReduction

◆ ForceMax

◆ ForceMin

◆ ForceSaturationVel

◆ ForceSpine3Share

◆ ForceStrength

◆ ForceThresholdVel

◆ LastStandHorizDamping

◆ LastStandMaxTime

◆ LastStandMode

◆ LastStandSinkRate

◆ NoSupportForceMult

◆ StayUpAcc

◆ StayUpAccMax

◆ StepUpHelp

◆ SupportPosition

◆ TorqueDamping

◆ TorqueOnlyInAir

◆ TorqueSaturationVel

◆ TorqueStrength

◆ TorqueThresholdVel

◆ TurnTowardsBullets

◆ UseForces

◆ UseTorques

◆ VelocityBased