Class BodyRelaxHelper

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

Inheritance
Object
CustomHelper
BodyRelaxHelper
Inherited Members
Namespace: GTA.NaturalMotion
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class BodyRelaxHelper : CustomHelper

Constructors

| Improve this Doc View Source

BodyRelaxHelper(Ped)

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

Declaration
public BodyRelaxHelper(Ped ped)
Parameters
Type Name Description
Ped ped

The Ped to send the BodyRelax Message to.
Remarks

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

Properties

| Improve this Doc View Source

Damping

Declaration
public float Damping { set; }
Property Value
Type Description
Single
Remarks

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

| Improve this Doc View Source

DisableJointDriving

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

Declaration
public bool DisableJointDriving { set; }
Property Value
Type Description
Boolean
Remarks

Default value = False.

| Improve this Doc View Source

HoldPose

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

Declaration
public bool HoldPose { set; }
Property Value
Type Description
Boolean
Remarks

Default value = False.

| Improve this Doc View Source

Mask

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).

Declaration
public string Mask { set; }
Property Value
Type Description
String
Remarks

Default value = "fb.

| Improve this Doc View Source

Relaxation

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

Declaration
public float Relaxation { set; }
Property Value
Type Description
Single
Remarks

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