Class ConfigureSelfAvoidanceHelper

This single message allows to configure self avoidance for the character.BBDD Self avoidance tech.

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

Constructors

| Improve this Doc View Source

ConfigureSelfAvoidanceHelper(Ped)

Creates a new Instance of the ConfigureSelfAvoidanceHelper for sending a ConfigureSelfAvoidance Message to a given Ped.

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

The Ped to send the ConfigureSelfAvoidance Message to.
Remarks

This single message allows to configure self avoidance for the character.BBDD Self avoidance tech.

Properties

| Improve this Doc View Source

MaxTorsoSwingAngleRad

Max value on the effector (wrist) to adjusted target offset.

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

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

| Improve this Doc View Source

OverwriteDragReduction

Specify whether self avoidance tech should use original IK input target or the target that has been already modified by getStabilisedPos() tech i.e. function that compensates for rotational and linear velocity of shoulder/thigh.

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

Default value = False.

| Improve this Doc View Source

OverwriteTwist

Overwrite desired IK twist with self avoidance procedural twist.

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

Default value = False.

| Improve this Doc View Source

Radius

Self avoidance radius, measured out from the spine axis along the plane perpendicular to that axis. The closer is the proximity of reaching target to that radius, the more polar (curved) motion is used for offsetting the target. WARNING: Parameter only used by the alternative algorithm that is based on linear and polar target blending.

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

Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.

| Improve this Doc View Source

SelfAvoidAmount

Amount of self avoidance offset applied when angle from effector (wrist) to target is greater then right angle i.e. when total offset is a blend between where effector currently is to value that is a product of total arm length and selfAvoidAmount. SelfAvoidAmount is in a range between [0, 1].

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

Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.

| Improve this Doc View Source

SelfAvoidIfInSpineBoundsOnly

Restrict self avoidance to operate on targets that are within character torso bounds only.

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

Default value = False.

| Improve this Doc View Source

TorsoSwingFraction

Place the adjusted target this much along the arc between effector (wrist) and target, value in range [0,1].

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

Default value = 0.8f. Min value = 0.0f. Max value = 1.0f.

| Improve this Doc View Source

UsePolarPathAlgorithm

Use the alternative self avoidance algorithm that is based on linear and polar target blending. WARNING: It only requires "radius" in terms of parametrization.

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

Default value = False.

| Improve this Doc View Source

UseSelfAvoidance

Enable or disable self avoidance tech.

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

Default value = False.