GTA.NaturalMotion.ConfigureLimitsHelper Class Reference

Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will not reorient the joint. More...

Inheritance diagram for GTA.NaturalMotion.ConfigureLimitsHelper:

Public Member Functions
	ConfigureLimitsHelper (Ped ped)
	Creates a new Instance of the ConfigureLimitsHelper for sending a ConfigureLimits 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
string	Mask [set]
	Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value for joint limits to configure. Ignored if index != -1. More...
bool	Enable [set]
	If false, disable (set all to PI, -PI) limits. More...
bool	ToDesired [set]
	If true, set limits to accommodate current desired angles. More...
bool	Restore [set]
	Return to cached defaults?. More...
bool	ToCurAnimation [set]
	If true, set limits to the current animated limits. More...
int	Index [set]
	Index of effector to configure. Set to -1 to use mask. More...
float	Lean1 [set]
	Custom limit values to use if not setting limits to desired. Limits are RAGE-native, not NM-wrapper-native. More...
float	Lean2 [set]
float	Twist [set]
float	Margin [set]
	Joint limit margin to add to current animation limits when using those to set runtime limits. 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...

Detailed Description

Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will not reorient the joint.

Constructor & Destructor Documentation

ConfigureLimitsHelper()

GTA.NaturalMotion.ConfigureLimitsHelper.ConfigureLimitsHelper

(

Ped

ped

)

Creates a new Instance of the ConfigureLimitsHelper for sending a ConfigureLimits Message to a given Ped.

Parameters

ped	The Ped to send the ConfigureLimits Message to.

Enable/disable/edit character limits in real time. This adjusts limits in RAGE-native space and will not reorient the joint.

Property Documentation

Enable

bool GTA.NaturalMotion.ConfigureLimitsHelper.Enable

set

If false, disable (set all to PI, -PI) limits.

Default value = True.

Index

int GTA.NaturalMotion.ConfigureLimitsHelper.Index

set

Index of effector to configure. Set to -1 to use mask.

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

Lean1

float GTA.NaturalMotion.ConfigureLimitsHelper.Lean1

set

Custom limit values to use if not setting limits to desired. Limits are RAGE-native, not NM-wrapper-native.

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

Lean2

float GTA.NaturalMotion.ConfigureLimitsHelper.Lean2

set

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

Margin

float GTA.NaturalMotion.ConfigureLimitsHelper.Margin

set

Joint limit margin to add to current animation limits when using those to set runtime limits.

Default value = 0.2f. Min value = 0.0f. Max value = 3.1f.

Mask

string GTA.NaturalMotion.ConfigureLimitsHelper.Mask

set

Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value for joint limits to configure. Ignored if index != -1.

Default value = "fb".

Restore

bool GTA.NaturalMotion.ConfigureLimitsHelper.Restore

set

Return to cached defaults?.

Default value = False.

ToCurAnimation

bool GTA.NaturalMotion.ConfigureLimitsHelper.ToCurAnimation

set

If true, set limits to the current animated limits.

Default value = False.

ToDesired

bool GTA.NaturalMotion.ConfigureLimitsHelper.ToDesired

set

If true, set limits to accommodate current desired angles.

Default value = False.

Twist

float GTA.NaturalMotion.ConfigureLimitsHelper.Twist

set

Default value = 1.6f. Min value = 0.0f. Max value = 3.1f.

---

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

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