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.BodyRelaxHelper Class Reference

Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state. More...

Inheritance diagram for GTA.NaturalMotion.BodyRelaxHelper:
GTA.NaturalMotion.CustomHelper

Public Member Functions

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

float Relaxation [set]
 How relaxed the body becomes, in percentage relaxed. 100 being totally rag-dolled, 0 being very stiff and rigid. More...
 
float Damping [set]
 
string Mask [set]
 Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values). More...
 
bool HoldPose [set]
 Automatically hold the current pose as the character relaxes - can be used to avoid relaxing into a t-pose. More...
 
bool DisableJointDriving [set]
 Sets the drive state to free - this reduces drifting on the ground. 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...
 

Detailed Description

Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state.

Constructor & Destructor Documentation

◆ BodyRelaxHelper()

GTA.NaturalMotion.BodyRelaxHelper.BodyRelaxHelper ( Ped  ped)

Creates a new Instance of the BodyRelaxHelper for sending a BodyRelax Message to a given Ped.

Parameters
pedThe Ped to send the BodyRelax Message to.

Set the amount of relaxation across the whole body; Used to collapse the character into a rag-doll-like state.

Property Documentation

◆ Damping

float GTA.NaturalMotion.BodyRelaxHelper.Damping
set

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

◆ DisableJointDriving

bool GTA.NaturalMotion.BodyRelaxHelper.DisableJointDriving
set

Sets the drive state to free - this reduces drifting on the ground.

Default value = False.

◆ HoldPose

bool GTA.NaturalMotion.BodyRelaxHelper.HoldPose
set

Automatically hold the current pose as the character relaxes - can be used to avoid relaxing into a t-pose.

Default value = False.

◆ Mask

string GTA.NaturalMotion.BodyRelaxHelper.Mask
set

Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Default value = "fb.

◆ Relaxation

float GTA.NaturalMotion.BodyRelaxHelper.Relaxation
set

How relaxed the body becomes, in percentage relaxed. 100 being totally rag-dolled, 0 being very stiff and rigid.

Default value = 50.0f. Min value = 0.0f. Max value = 100.0f.


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