Class ConfigureSoftLimitHelper

Inheritance

Object

CustomHelper

ConfigureSoftLimitHelper

Inherited Members

CustomHelper.Start()

CustomHelper.Start(Int32)

CustomHelper.Stop()

CustomHelper.SetArgument(String, Boolean)

CustomHelper.SetArgument(String, Int32)

CustomHelper.SetArgument(String, Single)

CustomHelper.SetArgument(String, String)

CustomHelper.SetArgument(String, Vector3)

CustomHelper.ResetArguments()

CustomHelper.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA.NaturalMotion

Assembly: ScriptHookVDotNet3.dll

Syntax

public sealed class ConfigureSoftLimitHelper : CustomHelper

Constructors

ConfigureSoftLimitHelper(Ped)

Creates a new Instance of the ConfigureSoftLimitHelper for sending a ConfigureSoftLimit Message to a given Ped.

Declaration

public ConfigureSoftLimitHelper(Ped ped)

Parameters

Type	Name	Description
Ped	ped	The Ped to send the ConfigureSoftLimit Message to.

Properties

ApproachDirection

Limit angle can be measured relatively to joints hard limit minAngle or maxAngle. Set it to +1 to measure soft limit angle relatively to hard limit minAngle that corresponds to the maximum stretch of the elbow. Set it to -1 to measure soft limit angle relatively to hard limit maxAngle that corresponds to the maximum stretch of the knee.

Declaration

public int ApproachDirection { set; }

Property Value

Type	Description
Int32

Remarks

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

Damping

Damping of the soft limit. Parameter is used to calculate damper term that contributes to the desired acceleration. To have the system critically dampened set it to 1.0.

Declaration

public float Damping { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.9f. Max value = 1.1f.

Index

Select limb that the soft limit is going to be applied to.

Declaration

public int Index { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = 0. Max value = 3.

LimitAngle

Soft limit angle. Positive angle in RAD, measured relatively either from hard limit maxAngle (approach direction = -1) or minAngle (approach direction = 1). This angle will be clamped if outside the joint hard limit range.

Declaration

public float LimitAngle { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.4f. Min value = 0.0f. Max value = 6.3f.

Stiffness

Stiffness of the soft limit. Parameter is used to calculate spring term that contributes to the desired acceleration.

Declaration

public float Stiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 15.0f. Min value = 0.0f. Max value = 30.0f.

VelocityScaled

Scale stiffness based on character angular velocity.

Declaration

public bool VelocityScaled { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.