Inheritance diagram for GTA.NaturalMotion.ForceLeanTowardsObjectHelper:

Public Member Functions
	ForceLeanTowardsObjectHelper (Ped ped)
	Creates a new Instance of the ForceLeanTowardsObjectHelper for sending a ForceLeanTowardsObject 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 move towards. More...

int	BoundIndex `[set]`
	BoundIndex of object to move towards (0 = just use instance coordinates). More...

int	BodyPart `[set]`
	Body part that the force is applied to. 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

◆ ForceLeanTowardsObjectHelper()

GTA.NaturalMotion.ForceLeanTowardsObjectHelper.ForceLeanTowardsObjectHelper ( Ped ped )

Creates a new Instance of the ForceLeanTowardsObjectHelper for sending a ForceLeanTowardsObject Message to a given Ped.

Parameters

ped	The Ped to send the ForceLeanTowardsObject Message to.

int GTA.NaturalMotion.ForceLeanTowardsObjectHelper.BodyPart

set

Body part that the force is applied to.

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

int GTA.NaturalMotion.ForceLeanTowardsObjectHelper.BoundIndex

set

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

Default value = 0. Min value = 0.

int GTA.NaturalMotion.ForceLeanTowardsObjectHelper.InstanceIndex

set

LevelIndex of object to move towards.

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

float GTA.NaturalMotion.ForceLeanTowardsObjectHelper.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.

Vector3 GTA.NaturalMotion.ForceLeanTowardsObjectHelper.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:

C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs