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

BEHAVIOURS REFERENCED: AnimPose - allows animPose to override body parts: Arms (useLeftArm, useRightArm). More...

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

Public Member Functions

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

Vector3 TargetLeft [set]
 Point to point to (in world space). More...
 
float TwistLeft [set]
 Twist of the arm around point direction. More...
 
float ArmStraightnessLeft [set]
 Values less than 1 can give the arm a more bent look. More...
 
bool UseLeftArm [set]
 
float ArmStiffnessLeft [set]
 Stiffness of arm. More...
 
float ArmDampingLeft [set]
 Damping value for arm used to point. More...
 
int InstanceIndexLeft [set]
 Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index. More...
 
float PointSwingLimitLeft [set]
 Swing limit. More...
 
bool UseZeroPoseWhenNotPointingLeft [set]
 
Vector3 TargetRight [set]
 Point to point to (in world space). More...
 
float TwistRight [set]
 Twist of the arm around point direction. More...
 
float ArmStraightnessRight [set]
 Values less than 1 can give the arm a more bent look. More...
 
bool UseRightArm [set]
 
float ArmStiffnessRight [set]
 Stiffness of arm. More...
 
float ArmDampingRight [set]
 Damping value for arm used to point. More...
 
int InstanceIndexRight [set]
 Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index. More...
 
float PointSwingLimitRight [set]
 Swing limit. More...
 
bool UseZeroPoseWhenNotPointingRight [set]
 

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

BEHAVIOURS REFERENCED: AnimPose - allows animPose to override body parts: Arms (useLeftArm, useRightArm).

Constructor & Destructor Documentation

◆ PointArmHelper()

GTA.NaturalMotion.PointArmHelper.PointArmHelper ( Ped  ped)

Creates a new Instance of the PointArmHelper for sending a PointArm Message to a given Ped.

Parameters
pedThe Ped to send the PointArm Message to.

BEHAVIOURS REFERENCED: AnimPose - allows animPose to override body parts: Arms (useLeftArm, useRightArm).

Property Documentation

◆ ArmDampingLeft

float GTA.NaturalMotion.PointArmHelper.ArmDampingLeft
set

Damping value for arm used to point.

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

◆ ArmDampingRight

float GTA.NaturalMotion.PointArmHelper.ArmDampingRight
set

Damping value for arm used to point.

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

◆ ArmStiffnessLeft

float GTA.NaturalMotion.PointArmHelper.ArmStiffnessLeft
set

Stiffness of arm.

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

◆ ArmStiffnessRight

float GTA.NaturalMotion.PointArmHelper.ArmStiffnessRight
set

Stiffness of arm.

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

◆ ArmStraightnessLeft

float GTA.NaturalMotion.PointArmHelper.ArmStraightnessLeft
set

Values less than 1 can give the arm a more bent look.

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

◆ ArmStraightnessRight

float GTA.NaturalMotion.PointArmHelper.ArmStraightnessRight
set

Values less than 1 can give the arm a more bent look.

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

◆ InstanceIndexLeft

int GTA.NaturalMotion.PointArmHelper.InstanceIndexLeft
set

Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

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

◆ InstanceIndexRight

int GTA.NaturalMotion.PointArmHelper.InstanceIndexRight
set

Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

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

◆ PointSwingLimitLeft

float GTA.NaturalMotion.PointArmHelper.PointSwingLimitLeft
set

Swing limit.

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

◆ PointSwingLimitRight

float GTA.NaturalMotion.PointArmHelper.PointSwingLimitRight
set

Swing limit.

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

◆ TargetLeft

Vector3 GTA.NaturalMotion.PointArmHelper.TargetLeft
set

Point to point to (in world space).

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

◆ TargetRight

Vector3 GTA.NaturalMotion.PointArmHelper.TargetRight
set

Point to point to (in world space).

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

◆ TwistLeft

float GTA.NaturalMotion.PointArmHelper.TwistLeft
set

Twist of the arm around point direction.

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

◆ TwistRight

float GTA.NaturalMotion.PointArmHelper.TwistRight
set

Twist of the arm around point direction.

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

◆ UseLeftArm

bool GTA.NaturalMotion.PointArmHelper.UseLeftArm
set

Default value = False.

◆ UseRightArm

bool GTA.NaturalMotion.PointArmHelper.UseRightArm
set

Default value = False.

◆ UseZeroPoseWhenNotPointingLeft

bool GTA.NaturalMotion.PointArmHelper.UseZeroPoseWhenNotPointingLeft
set

Default value = False.

◆ UseZeroPoseWhenNotPointingRight

bool GTA.NaturalMotion.PointArmHelper.UseZeroPoseWhenNotPointingRight
set

Default value = False.


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