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

Public Member Functions

 LeanTowardsObjectHelper (Ped ped)
 Creates a new Instance of the LeanTowardsObjectHelper for sending a LeanTowardsObject 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 LeanAmount [set]
 Amount of lean, 0 to about 0.5. -ve will move away from the target. More...
 
Vector3 Offset [set]
 Offset from instance position added when calculating position to lean to. More...
 
int InstanceIndex [set]
 LevelIndex of object to lean towards. More...
 
int BoundIndex [set]
 BoundIndex of object to lean towards (0 = just use instance coordinates). 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

◆ LeanTowardsObjectHelper()

GTA.NaturalMotion.LeanTowardsObjectHelper.LeanTowardsObjectHelper ( Ped  ped)

Creates a new Instance of the LeanTowardsObjectHelper for sending a LeanTowardsObject Message to a given Ped.

Parameters
pedThe Ped to send the LeanTowardsObject Message to.

Property Documentation

◆ BoundIndex

int GTA.NaturalMotion.LeanTowardsObjectHelper.BoundIndex
set

BoundIndex of object to lean towards (0 = just use instance coordinates).

Default value = 0. Min value = 0.

◆ InstanceIndex

int GTA.NaturalMotion.LeanTowardsObjectHelper.InstanceIndex
set

LevelIndex of object to lean towards.

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

◆ LeanAmount

float GTA.NaturalMotion.LeanTowardsObjectHelper.LeanAmount
set

Amount of lean, 0 to about 0.5. -ve will move away from the target.

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

◆ Offset

Vector3 GTA.NaturalMotion.LeanTowardsObjectHelper.Offset
set

Offset from instance position added when calculating position to lean to.

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


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