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

Apply an impulse to a named body part. More...

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

Public Member Functions

 ForceToBodyPartHelper (Ped ped)
 Creates a new Instance of the ForceToBodyPartHelper for sending a ForceToBodyPart 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 PartIndex [set]
 Part or link or bound index. More...
 
Vector3 Force [set]
 Force to apply. More...
 
bool ForceDefinedInPartSpace [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

Apply an impulse to a named body part.

Constructor & Destructor Documentation

◆ ForceToBodyPartHelper()

GTA.NaturalMotion.ForceToBodyPartHelper.ForceToBodyPartHelper ( Ped  ped)

Creates a new Instance of the ForceToBodyPartHelper for sending a ForceToBodyPart Message to a given Ped.

Parameters
pedThe Ped to send the ForceToBodyPart Message to.

Apply an impulse to a named body part.

Property Documentation

◆ Force

Vector3 GTA.NaturalMotion.ForceToBodyPartHelper.Force
set

Force to apply.

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

◆ ForceDefinedInPartSpace

bool GTA.NaturalMotion.ForceToBodyPartHelper.ForceDefinedInPartSpace
set

Default value = False.

◆ PartIndex

int GTA.NaturalMotion.ForceToBodyPartHelper.PartIndex
set

Part or link or bound index.

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


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