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.UpperBodyFlinchHelper Class Reference
Inheritance diagram for GTA.NaturalMotion.UpperBodyFlinchHelper:
GTA.NaturalMotion.CustomHelper

Public Member Functions

 UpperBodyFlinchHelper (Ped ped)
 Creates a new Instance of the UpperBodyFlinchHelper for sending a UpperBodyFlinch 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 HandDistanceLeftRight [set]
 Left-Right distance between the hands. More...
 
float HandDistanceFrontBack [set]
 Front-Back distance between the hands. More...
 
float HandDistanceVertical [set]
 Vertical distance between the hands. More...
 
float BodyStiffness [set]
 Stiffness of body. Value carries over to head look, spine twist. More...
 
float BodyDamping [set]
 Damping value used for upper body. More...
 
float BackBendAmount [set]
 Amount to bend the back during the flinch. More...
 
bool UseRightArm [set]
 Toggle to use the right arm. More...
 
bool UseLeftArm [set]
 Toggle to Use the Left arm. More...
 
float NoiseScale [set]
 Amplitude of the perlin noise applied to the arms positions in the flinch to the front part of the behavior. More...
 
bool NewHit [set]
 Relaxes the character for 1 frame if set. More...
 
bool ProtectHeadToggle [set]
 Always protect head. Note if false then character flinches if target is in front, protects head if target is behind. More...
 
bool DontBraceHead [set]
 Don't protect head only brace from front. Turned on by bcr. More...
 
bool ApplyStiffness [set]
 Turned of by bcr. More...
 
bool HeadLookAwayFromTarget [set]
 Look away from target (unless protecting head then look between feet). More...
 
bool UseHeadLook [set]
 Use headlook. More...
 
int TurnTowards [set]
 Ve balancer turn Towards, negative balancer turn Away, 0 balancer won't turn. There is a 50% chance that the character will not turn even if this parameter is set to turn. More...
 
Vector3 Pos [set]
 Position in world-space of object to flinch from. 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

◆ UpperBodyFlinchHelper()

GTA.NaturalMotion.UpperBodyFlinchHelper.UpperBodyFlinchHelper ( Ped  ped)

Creates a new Instance of the UpperBodyFlinchHelper for sending a UpperBodyFlinch Message to a given Ped.

Parameters
pedThe Ped to send the UpperBodyFlinch Message to.

Property Documentation

◆ ApplyStiffness

bool GTA.NaturalMotion.UpperBodyFlinchHelper.ApplyStiffness
set

Turned of by bcr.

Default value = True.

◆ BackBendAmount

float GTA.NaturalMotion.UpperBodyFlinchHelper.BackBendAmount
set

Amount to bend the back during the flinch.

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

◆ BodyDamping

float GTA.NaturalMotion.UpperBodyFlinchHelper.BodyDamping
set

Damping value used for upper body.

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

◆ BodyStiffness

float GTA.NaturalMotion.UpperBodyFlinchHelper.BodyStiffness
set

Stiffness of body. Value carries over to head look, spine twist.

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

◆ DontBraceHead

bool GTA.NaturalMotion.UpperBodyFlinchHelper.DontBraceHead
set

Don't protect head only brace from front. Turned on by bcr.

Default value = False.

◆ HandDistanceFrontBack

float GTA.NaturalMotion.UpperBodyFlinchHelper.HandDistanceFrontBack
set

Front-Back distance between the hands.

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

◆ HandDistanceLeftRight

float GTA.NaturalMotion.UpperBodyFlinchHelper.HandDistanceLeftRight
set

Left-Right distance between the hands.

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

◆ HandDistanceVertical

float GTA.NaturalMotion.UpperBodyFlinchHelper.HandDistanceVertical
set

Vertical distance between the hands.

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

◆ HeadLookAwayFromTarget

bool GTA.NaturalMotion.UpperBodyFlinchHelper.HeadLookAwayFromTarget
set

Look away from target (unless protecting head then look between feet).

Default value = False.

◆ NewHit

bool GTA.NaturalMotion.UpperBodyFlinchHelper.NewHit
set

Relaxes the character for 1 frame if set.

Default value = True.

◆ NoiseScale

float GTA.NaturalMotion.UpperBodyFlinchHelper.NoiseScale
set

Amplitude of the perlin noise applied to the arms positions in the flinch to the front part of the behavior.

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

◆ Pos

Vector3 GTA.NaturalMotion.UpperBodyFlinchHelper.Pos
set

Position in world-space of object to flinch from.

Default value = Vector3(0.0f, 0.0f, 0.0f).

◆ ProtectHeadToggle

bool GTA.NaturalMotion.UpperBodyFlinchHelper.ProtectHeadToggle
set

Always protect head. Note if false then character flinches if target is in front, protects head if target is behind.

Default value = False.

◆ TurnTowards

int GTA.NaturalMotion.UpperBodyFlinchHelper.TurnTowards
set

Ve balancer turn Towards, negative balancer turn Away, 0 balancer won't turn. There is a 50% chance that the character will not turn even if this parameter is set to turn.

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

◆ UseHeadLook

bool GTA.NaturalMotion.UpperBodyFlinchHelper.UseHeadLook
set

Use headlook.

Default value = True.

◆ UseLeftArm

bool GTA.NaturalMotion.UpperBodyFlinchHelper.UseLeftArm
set

Toggle to Use the Left arm.

Default value = True.

◆ UseRightArm

bool GTA.NaturalMotion.UpperBodyFlinchHelper.UseRightArm
set

Toggle to use the right arm.

Default value = True.


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