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

Public Member Functions

 ArmsWindmillHelper (Ped ped)
 Creates a new Instance of the ArmsWindmillHelper for sending a ArmsWindmill 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 LeftPartID [set]
 ID of part that the circle uses as local space for positioning. More...
 
float LeftRadius1 [set]
 Radius for first axis of ellipse. More...
 
float LeftRadius2 [set]
 Radius for second axis of ellipse. More...
 
float LeftSpeed [set]
 Speed of target around the circle. More...
 
Vector3 LeftNormal [set]
 Euler Angles orientation of circle in space of part with part ID. More...
 
Vector3 LeftCentre [set]
 Centre of circle in the space of partID. More...
 
int RightPartID [set]
 ID of part that the circle uses as local space for positioning. More...
 
float RightRadius1 [set]
 Radius for first axis of ellipse. More...
 
float RightRadius2 [set]
 Radius for second axis of ellipse. More...
 
float RightSpeed [set]
 Speed of target around the circle. More...
 
Vector3 RightNormal [set]
 Euler Angles orientation of circle in space of part with part ID. More...
 
Vector3 RightCentre [set]
 Centre of circle in the space of partID. More...
 
float ShoulderStiffness [set]
 Stiffness applied to the shoulders. More...
 
float ShoulderDamping [set]
 Damping applied to the shoulders. More...
 
float ElbowStiffness [set]
 Stiffness applied to the elbows. More...
 
float ElbowDamping [set]
 Damping applied to the elbows. More...
 
float LeftElbowMin [set]
 Minimum left elbow bend. More...
 
float RightElbowMin [set]
 Minimum right elbow bend. More...
 
float PhaseOffset [set]
 Phase offset(degrees) when phase synchronization is turned on. More...
 
float DragReduction [set]
 How much to compensate for movement of character/target. More...
 
float IKtwist [set]
 Angle of elbow around twist axis ?. More...
 
float AngVelThreshold [set]
 Value of character angular speed above which adaptive arm motion starts. More...
 
float AngVelGain [set]
 Multiplies angular speed of character to get speed of arms. More...
 
MirrorMode MirrorMode [set]
 
AdaptiveMode AdaptiveMode [set]
 
bool ForceSync [set]
 Toggles phase synchronization. More...
 
bool UseLeft [set]
 Use the left arm. More...
 
bool UseRight [set]
 Use the right arm. More...
 
bool DisableOnImpact [set]
 If true, each arm will stop windmilling if it hits 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...
 

Constructor & Destructor Documentation

◆ ArmsWindmillHelper()

GTA.NaturalMotion.ArmsWindmillHelper.ArmsWindmillHelper ( Ped  ped)

Creates a new Instance of the ArmsWindmillHelper for sending a ArmsWindmill Message to a given Ped.

Parameters
pedThe Ped to send the ArmsWindmill Message to.

Property Documentation

◆ AdaptiveMode

AdaptiveMode GTA.NaturalMotion.ArmsWindmillHelper.AdaptiveMode
set

Default value = AdaptiveMode.NotAdaptive.

◆ AngVelGain

float GTA.NaturalMotion.ArmsWindmillHelper.AngVelGain
set

Multiplies angular speed of character to get speed of arms.

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

◆ AngVelThreshold

float GTA.NaturalMotion.ArmsWindmillHelper.AngVelThreshold
set

Value of character angular speed above which adaptive arm motion starts.

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

◆ DisableOnImpact

bool GTA.NaturalMotion.ArmsWindmillHelper.DisableOnImpact
set

If true, each arm will stop windmilling if it hits the ground.

Default value = True.

◆ DragReduction

float GTA.NaturalMotion.ArmsWindmillHelper.DragReduction
set

How much to compensate for movement of character/target.

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

◆ ElbowDamping

float GTA.NaturalMotion.ArmsWindmillHelper.ElbowDamping
set

Damping applied to the elbows.

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

◆ ElbowStiffness

float GTA.NaturalMotion.ArmsWindmillHelper.ElbowStiffness
set

Stiffness applied to the elbows.

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

◆ ForceSync

bool GTA.NaturalMotion.ArmsWindmillHelper.ForceSync
set

Toggles phase synchronization.

Default value = True.

◆ IKtwist

float GTA.NaturalMotion.ArmsWindmillHelper.IKtwist
set

Angle of elbow around twist axis ?.

Default value = 0.0f. Min value = -3.1f. Max value = 3.1f.

◆ LeftCentre

Vector3 GTA.NaturalMotion.ArmsWindmillHelper.LeftCentre
set

Centre of circle in the space of partID.

Default value = Vector3(0.0f, 0.5f, -0.1f).

◆ LeftElbowMin

float GTA.NaturalMotion.ArmsWindmillHelper.LeftElbowMin
set

Minimum left elbow bend.

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

◆ LeftNormal

Vector3 GTA.NaturalMotion.ArmsWindmillHelper.LeftNormal
set

Euler Angles orientation of circle in space of part with part ID.

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

◆ LeftPartID

int GTA.NaturalMotion.ArmsWindmillHelper.LeftPartID
set

ID of part that the circle uses as local space for positioning.

Default value = 10. Min value = 0. Max value = 21.

◆ LeftRadius1

float GTA.NaturalMotion.ArmsWindmillHelper.LeftRadius1
set

Radius for first axis of ellipse.

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

◆ LeftRadius2

float GTA.NaturalMotion.ArmsWindmillHelper.LeftRadius2
set

Radius for second axis of ellipse.

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

◆ LeftSpeed

float GTA.NaturalMotion.ArmsWindmillHelper.LeftSpeed
set

Speed of target around the circle.

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

◆ MirrorMode

MirrorMode GTA.NaturalMotion.ArmsWindmillHelper.MirrorMode
set

Default value = MirrorMode.Mirrored. If MirrorMode.Parallel leftArm parameters are used.

◆ PhaseOffset

float GTA.NaturalMotion.ArmsWindmillHelper.PhaseOffset
set

Phase offset(degrees) when phase synchronization is turned on.

Default value = 0.0f. Min value = -360.0f. Max value = 360.0f.

◆ RightCentre

Vector3 GTA.NaturalMotion.ArmsWindmillHelper.RightCentre
set

Centre of circle in the space of partID.

Default value = Vector3(0.0f, -0.5f, -0.1f).

◆ RightElbowMin

float GTA.NaturalMotion.ArmsWindmillHelper.RightElbowMin
set

Minimum right elbow bend.

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

◆ RightNormal

Vector3 GTA.NaturalMotion.ArmsWindmillHelper.RightNormal
set

Euler Angles orientation of circle in space of part with part ID.

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

◆ RightPartID

int GTA.NaturalMotion.ArmsWindmillHelper.RightPartID
set

ID of part that the circle uses as local space for positioning.

Default value = 10. Min value = 0. Max value = 21.

◆ RightRadius1

float GTA.NaturalMotion.ArmsWindmillHelper.RightRadius1
set

Radius for first axis of ellipse.

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

◆ RightRadius2

float GTA.NaturalMotion.ArmsWindmillHelper.RightRadius2
set

Radius for second axis of ellipse.

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

◆ RightSpeed

float GTA.NaturalMotion.ArmsWindmillHelper.RightSpeed
set

Speed of target around the circle.

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

◆ ShoulderDamping

float GTA.NaturalMotion.ArmsWindmillHelper.ShoulderDamping
set

Damping applied to the shoulders.

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

◆ ShoulderStiffness

float GTA.NaturalMotion.ArmsWindmillHelper.ShoulderStiffness
set

Stiffness applied to the shoulders.

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

◆ UseLeft

bool GTA.NaturalMotion.ArmsWindmillHelper.UseLeft
set

Use the left arm.

Default value = True.

◆ UseRight

bool GTA.NaturalMotion.ArmsWindmillHelper.UseRight
set

Use the right arm.

Default value = True.


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