SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.NaturalMotion.ConfigureSelfAvoidanceHelper Class Reference

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

Inheritance diagram for GTA.NaturalMotion.ConfigureSelfAvoidanceHelper:
GTA.NaturalMotion.CustomHelper

Public Member Functions

 ConfigureSelfAvoidanceHelper (Ped ped)
 Creates a new Instance of the ConfigureSelfAvoidanceHelper for sending a ConfigureSelfAvoidance 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

bool UseSelfAvoidance [set]
 Enable or disable self avoidance tech. More...
 
bool OverwriteDragReduction [set]
 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. More...
 
float TorsoSwingFraction [set]
 Place the adjusted target this much along the arc between effector (wrist) and target, value in range [0,1]. More...
 
float MaxTorsoSwingAngleRad [set]
 Max value on the effector (wrist) to adjusted target offset. More...
 
bool SelfAvoidIfInSpineBoundsOnly [set]
 Restrict self avoidance to operate on targets that are within character torso bounds only. More...
 
float SelfAvoidAmount [set]
 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]. More...
 
bool OverwriteTwist [set]
 Overwrite desired IK twist with self avoidance procedural twist. More...
 
bool UsePolarPathAlgorithm [set]
 Use the alternative self avoidance algorithm that is based on linear and polar target blending. WARNING: It only requires "radius" in terms of parametrization. More...
 
float Radius [set]
 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. 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

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

Constructor & Destructor Documentation

◆ ConfigureSelfAvoidanceHelper()

GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.ConfigureSelfAvoidanceHelper ( Ped  ped)

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

Parameters
pedThe Ped to send the ConfigureSelfAvoidance Message to.

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

Property Documentation

◆ MaxTorsoSwingAngleRad

float GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.MaxTorsoSwingAngleRad
set

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

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

◆ OverwriteDragReduction

bool GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.OverwriteDragReduction
set

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.

Default value = False.

◆ OverwriteTwist

bool GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.OverwriteTwist
set

Overwrite desired IK twist with self avoidance procedural twist.

Default value = False.

◆ Radius

float GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.Radius
set

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.

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

◆ SelfAvoidAmount

float GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.SelfAvoidAmount
set

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].

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

◆ SelfAvoidIfInSpineBoundsOnly

bool GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.SelfAvoidIfInSpineBoundsOnly
set

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

Default value = False.

◆ TorsoSwingFraction

float GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.TorsoSwingFraction
set

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

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

◆ UsePolarPathAlgorithm

bool GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.UsePolarPathAlgorithm
set

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

Default value = False.

◆ UseSelfAvoidance

bool GTA.NaturalMotion.ConfigureSelfAvoidanceHelper.UseSelfAvoidance
set

Enable or disable self avoidance tech.

Default value = False.


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