Class ConfigureLimitsHelper

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

Inheritance
Object
CustomHelper
ConfigureLimitsHelper
Inherited Members
Namespace: GTA.NaturalMotion
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class ConfigureLimitsHelper : CustomHelper

Constructors

| Improve this Doc View Source

ConfigureLimitsHelper(Ped)

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

Declaration
public ConfigureLimitsHelper(Ped ped)
Parameters
Type Name Description
Ped ped

The Ped to send the ConfigureLimits Message to.
Remarks

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

Properties

| Improve this Doc View Source

Enable

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

Declaration
public bool Enable { set; }
Property Value
Type Description
Boolean
Remarks

Default value = True.

| Improve this Doc View Source

Index

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

Declaration
public int Index { set; }
Property Value
Type Description
Int32
Remarks

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

| Improve this Doc View Source

Lean1

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

Declaration
public float Lean1 { set; }
Property Value
Type Description
Single
Remarks

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

| Improve this Doc View Source

Lean2

Declaration
public float Lean2 { set; }
Property Value
Type Description
Single
Remarks

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

| Improve this Doc View Source

Margin

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

Declaration
public float Margin { set; }
Property Value
Type Description
Single
Remarks

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

| Improve this Doc View Source

Mask

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.

Declaration
public string Mask { set; }
Property Value
Type Description
String
Remarks

Default value = "fb".

| Improve this Doc View Source

Restore

Return to cached defaults?.

Declaration
public bool Restore { set; }
Property Value
Type Description
Boolean
Remarks

Default value = False.

| Improve this Doc View Source

ToCurAnimation

If true, set limits to the current animated limits.

Declaration
public bool ToCurAnimation { set; }
Property Value
Type Description
Boolean
Remarks

Default value = False.

| Improve this Doc View Source

ToDesired

If true, set limits to accommodate current desired angles.

Declaration
public bool ToDesired { set; }
Property Value
Type Description
Boolean
Remarks

Default value = False.

| Improve this Doc View Source

Twist

Declaration
public float Twist { set; }
Property Value
Type Description
Single
Remarks

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