Class StayUprightHelper

Inheritance

Object

CustomHelper

StayUprightHelper

Inherited Members

CustomHelper.Start()

CustomHelper.Start(Int32)

CustomHelper.Stop()

CustomHelper.SetArgument(String, Boolean)

CustomHelper.SetArgument(String, Int32)

CustomHelper.SetArgument(String, Single)

CustomHelper.SetArgument(String, String)

CustomHelper.SetArgument(String, Vector3)

CustomHelper.ResetArguments()

CustomHelper.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA.NaturalMotion

Assembly: ScriptHookVDotNet3.dll

Syntax

public sealed class StayUprightHelper : CustomHelper

Constructors

StayUprightHelper(Ped)

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

Declaration

public StayUprightHelper(Ped ped)

Parameters

Type	Name	Description
Ped	ped	The Ped to send the StayUpright Message to.

Properties

ForceDamping

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

Declaration

public float ForceDamping { set; }

Property Value

Type	Description
Single

Remarks

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

ForceFeetMult

Multiplier to the force applied to the feet.

Declaration

public float ForceFeetMult { set; }

Property Value

Type	Description
Single

Remarks

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

ForceInAirShare

Share of the feet force to the airborne foot.

Declaration

public float ForceInAirShare { set; }

Property Value

Type	Description
Single

Remarks

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

ForceLeanReduction

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

Declaration

public float ForceLeanReduction { set; }

Property Value

Type	Description
Single

Remarks

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

ForceMax

See above.

Declaration

public float ForceMax { set; }

Property Value

Type	Description
Single

Remarks

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

ForceMin

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.

Declaration

public float ForceMin { set; }

Property Value

Type	Description
Single

Remarks

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

ForceSaturationVel

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

Declaration

public float ForceSaturationVel { set; }

Property Value

Type	Description
Single

Remarks

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

ForceSpine3Share

Share of pelvis force applied to spine3.

Declaration

public float ForceSpine3Share { set; }

Property Value

Type	Description
Single

Remarks

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

ForceStrength

Strength of constraint.

Declaration

public float ForceStrength { set; }

Property Value

Type	Description
Single

Remarks

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

ForceThresholdVel

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

Declaration

public float ForceThresholdVel { set; }

Property Value

Type	Description
Single

Remarks

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

LastStandHorizDamping

Higher values for more damping.

Declaration

public float LastStandHorizDamping { set; }

Property Value

Type	Description
Single

Remarks

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

LastStandMaxTime

Max time allowed in last stand mode.

Declaration

public float LastStandMaxTime { set; }

Property Value

Type	Description
Single

Remarks

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

LastStandMode

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

Declaration

public bool LastStandMode { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

LastStandSinkRate

The sink rate (higher for a faster drop).

Declaration

public float LastStandSinkRate { set; }

Property Value

Type	Description
Single

Remarks

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

NoSupportForceMult

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.

Declaration

public float NoSupportForceMult { set; }

Property Value

Type	Description
Single

Remarks

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

StayUpAcc

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

Declaration

public float StayUpAcc { set; }

Property Value

Type	Description
Single

Remarks

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

StayUpAccMax

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

Declaration

public float StayUpAccMax { set; }

Property Value

Type	Description
Single

Remarks

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

StepUpHelp

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

Declaration

public float StepUpHelp { set; }

Property Value

Type	Description
Single

Remarks

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

SupportPosition

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

Declaration

public float SupportPosition { set; }

Property Value

Type	Description
Single

Remarks

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

TorqueDamping

Damping of torque based constraint.

Declaration

public float TorqueDamping { set; }

Property Value

Type	Description
Single

Remarks

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

TorqueOnlyInAir

Only apply torque based constraint when airBorne.

Declaration

public bool TorqueOnlyInAir { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

TorqueSaturationVel

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

Declaration

public float TorqueSaturationVel { set; }

Property Value

Type	Description
Single

Remarks

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

TorqueStrength

Strength of torque based constraint.

Declaration

public float TorqueStrength { set; }

Property Value

Type	Description
Single

Remarks

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

TorqueThresholdVel

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

Declaration

public float TorqueThresholdVel { set; }

Property Value

Type	Description
Single

Remarks

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

TurnTowardsBullets

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

Declaration

public bool TurnTowardsBullets { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseForces

Enable force based constraint.

Declaration

public bool UseForces { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseTorques

Enable torque based constraint.

Declaration

public bool UseTorques { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

VelocityBased

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

Declaration

public bool VelocityBased { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.