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

Public Member Functions

 ApplyImpulseHelper (Ped ped)
 Creates a new Instance of the ApplyImpulseHelper for sending a ApplyImpulse 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 EqualizeAmount [set]
 0 means straight impulse, 1 means multiply by the mass (change in velocity). More...
 
int PartIndex [set]
 Index of part being hit. -1 apply impulse to COM. More...
 
Vector3 Impulse [set]
 Impulse vector (impulse is change in momentum). More...
 
Vector3 HitPoint [set]
 Optional point on part where hit. If not supplied then the impulse is applied at the part center. More...
 
bool LocalHitPointInfo [set]
 Hit point in local coordinates of body part. More...
 
bool LocalImpulseInfo [set]
 Impulse in local coordinates of body part. More...
 
bool AngularImpulse [set]
 Impulse should be considered an angular impulse. 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

◆ ApplyImpulseHelper()

GTA.NaturalMotion.ApplyImpulseHelper.ApplyImpulseHelper ( Ped  ped)

Creates a new Instance of the ApplyImpulseHelper for sending a ApplyImpulse Message to a given Ped.

Parameters
pedThe Ped to send the ApplyImpulse Message to.

Property Documentation

◆ AngularImpulse

bool GTA.NaturalMotion.ApplyImpulseHelper.AngularImpulse
set

Impulse should be considered an angular impulse.

Default value = False.

◆ EqualizeAmount

float GTA.NaturalMotion.ApplyImpulseHelper.EqualizeAmount
set

0 means straight impulse, 1 means multiply by the mass (change in velocity).

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

◆ HitPoint

Vector3 GTA.NaturalMotion.ApplyImpulseHelper.HitPoint
set

Optional point on part where hit. If not supplied then the impulse is applied at the part center.

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

◆ Impulse

Vector3 GTA.NaturalMotion.ApplyImpulseHelper.Impulse
set

Impulse vector (impulse is change in momentum).

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -4500.0f. Max value = 4500.0f.

◆ LocalHitPointInfo

bool GTA.NaturalMotion.ApplyImpulseHelper.LocalHitPointInfo
set

Hit point in local coordinates of body part.

Default value = False.

◆ LocalImpulseInfo

bool GTA.NaturalMotion.ApplyImpulseHelper.LocalImpulseInfo
set

Impulse in local coordinates of body part.

Default value = False.

◆ PartIndex

int GTA.NaturalMotion.ApplyImpulseHelper.PartIndex
set

Index of part being hit. -1 apply impulse to COM.

Default value = 0. Min value = -1. Max value = 28.


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