SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.NaturalMotion.ConfigureSoftLimitHelper Class Reference
Inheritance diagram for GTA.NaturalMotion.ConfigureSoftLimitHelper:
GTA.NaturalMotion.CustomHelper

Public Member Functions

 ConfigureSoftLimitHelper (Ped ped)
 Creates a new Instance of the ConfigureSoftLimitHelper for sending a ConfigureSoftLimit 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

int Index [set]
 Select limb that the soft limit is going to be applied to. More...
 
float Stiffness [set]
 Stiffness of the soft limit. Parameter is used to calculate spring term that contributes to the desired acceleration. More...
 
float Damping [set]
 Damping of the soft limit. Parameter is used to calculate damper term that contributes to the desired acceleration. To have the system critically dampened set it to 1.0. More...
 
float LimitAngle [set]
 Soft limit angle. Positive angle in RAD, measured relatively either from hard limit maxAngle (approach direction = -1) or minAngle (approach direction = 1). This angle will be clamped if outside the joint hard limit range. More...
 
int ApproachDirection [set]
 Limit angle can be measured relatively to joints hard limit minAngle or maxAngle. Set it to +1 to measure soft limit angle relatively to hard limit minAngle that corresponds to the maximum stretch of the elbow. Set it to -1 to measure soft limit angle relatively to hard limit maxAngle that corresponds to the maximum stretch of the knee. More...
 
bool VelocityScaled [set]
 Scale stiffness based on character angular velocity. 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

◆ ConfigureSoftLimitHelper()

GTA.NaturalMotion.ConfigureSoftLimitHelper.ConfigureSoftLimitHelper ( Ped  ped)

Creates a new Instance of the ConfigureSoftLimitHelper for sending a ConfigureSoftLimit Message to a given Ped.

Parameters
pedThe Ped to send the ConfigureSoftLimit Message to.

Property Documentation

◆ ApproachDirection

int GTA.NaturalMotion.ConfigureSoftLimitHelper.ApproachDirection
set

Limit angle can be measured relatively to joints hard limit minAngle or maxAngle. Set it to +1 to measure soft limit angle relatively to hard limit minAngle that corresponds to the maximum stretch of the elbow. Set it to -1 to measure soft limit angle relatively to hard limit maxAngle that corresponds to the maximum stretch of the knee.

Default value = 1. Min value = -1. Max value = 1.

◆ Damping

float GTA.NaturalMotion.ConfigureSoftLimitHelper.Damping
set

Damping of the soft limit. Parameter is used to calculate damper term that contributes to the desired acceleration. To have the system critically dampened set it to 1.0.

Default value = 1.0f. Min value = 0.9f. Max value = 1.1f.

◆ Index

int GTA.NaturalMotion.ConfigureSoftLimitHelper.Index
set

Select limb that the soft limit is going to be applied to.

Default value = 0. Min value = 0. Max value = 3.

◆ LimitAngle

float GTA.NaturalMotion.ConfigureSoftLimitHelper.LimitAngle
set

Soft limit angle. Positive angle in RAD, measured relatively either from hard limit maxAngle (approach direction = -1) or minAngle (approach direction = 1). This angle will be clamped if outside the joint hard limit range.

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

◆ Stiffness

float GTA.NaturalMotion.ConfigureSoftLimitHelper.Stiffness
set

Stiffness of the soft limit. Parameter is used to calculate spring term that contributes to the desired acceleration.

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

◆ VelocityScaled

bool GTA.NaturalMotion.ConfigureSoftLimitHelper.VelocityScaled
set

Scale stiffness based on character angular velocity.

Default value = False.


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