Class BodyBalanceHelper

Inheritance

Object

CustomHelper

BodyBalanceHelper

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 BodyBalanceHelper : CustomHelper

Constructors

BodyBalanceHelper(Ped)

Creates a new Instance of the BodyBalanceHelper for sending a BodyBalance Message to a given Ped.

Declaration

public BodyBalanceHelper(Ped ped)

Parameters

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

Properties

AngVelMultiplier

Somersault, twist, sideSomersault) multiplier of the angular velocity for arms out (lean2) (somersault, twist, sideSomersault).

Declaration

public Vector3 AngVelMultiplier { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(4.0f, 1.0f, 4.0f). Min value = 0.0f. Max value = 20.0f.

AngVelThreshold

Somersault, twist, sideSomersault) threshold above which angVel is used for arms out (lean2) Unless drunk - DO NOT EXCEED 7.0 for each component.

Declaration

public Vector3 AngVelThreshold { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(1.2f, 3.0f, 1.2f). Min value = 0.0f. Max value = 40.0f.

ArmDamping

NB. WAS m_damping NeckDamping=1 ClaviclesDamping=1.

Declaration

public float ArmDamping { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.7f. Min value = 0.0f. Max value = 2.0f.

ArmsOutMinLean2

Minimum desiredLean2 applied to shoulder (to stop arms going above shoulder height or not).

Declaration

public float ArmsOutMinLean2 { set; }

Property Value

Type	Description
Single

Remarks

Default value = -9.9f. Min value = -10.0f. Max value = 0.0f.

ArmsOutOnPush

Put arms out based on lean2 of legs, or angular velocity (lean or twist), or lean (front/back or side/side).

Declaration

public bool ArmsOutOnPush { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

ArmsOutOnPushMultiplier

Arms out based on lean2 of the legs to simulate being pushed.

Declaration

public float ArmsOutOnPushMultiplier { set; }

Property Value

Type	Description
Single

Remarks

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

ArmsOutOnPushTimeout

Number of seconds before turning off the armsOutOnPush response only for Arms out based on lean2 of the legs (NOT for the angle or angular velocity).

Declaration

public float ArmsOutOnPushTimeout { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.1f. Min value = 0.0f. Max value = 2.0f.

ArmsOutStraightenElbows

Multiplier for straightening the elbows based on the amount of arms out(lean2) 0 = dont straighten elbows. Otherwise straighten elbows proportionately to armsOut.

Declaration

public float ArmsOutStraightenElbows { set; }

Property Value

Type	Description
Single

Remarks

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

ArmStiffness

NB. WAS m_bodyStiffness ClaviclesStiffness=9.0f.

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 9.0f. Min value = 6.0f. Max value = 16.0f.

BackwardsArms

Bend elbows, relax shoulders and inhibit spine twist when moving backwards.

Declaration

public bool BackwardsArms { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

BackwardsAutoTurn

Automatically turn around if moving backwards.

Declaration

public bool BackwardsAutoTurn { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

BendElbowsGait

Minimum desired angle of elbow during non contact arm swing.

Declaration

public float BendElbowsGait { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.7f. Min value = -3.0f. Max value = 3.0f.

BendElbowsTime

Time after contact (with Upper body) that the min m_elbowAngleOnContact is applied.

Declaration

public float BendElbowsTime { set; }

Property Value

Type	Description
Single

Remarks

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

BlendToZeroPose

Blend upper body to zero pose as the character comes to rest. If false blend to a stored pose.

Declaration

public bool BlendToZeroPose { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

BraceDistance

If -ve then do not brace. distance from object at which to raise hands to brace 0.5 good if newBrace=true - otherwise 0.65.

Declaration

public float BraceDistance { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

BraceOffset

BraceTarget is global headLookPos plus braceOffset m in the up direction.

Declaration

public float BraceOffset { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -2.0f. Max value = 2.0f.

BraceStiffness

Stiffness of character. Catch_fall stiffness scales with this too, with its defaults at this values default.

Declaration

public float BraceStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 12.0f. Min value = 6.0f. Max value = 16.0f.

Elbow

How much the elbow swings based on the leg movement.

Declaration

public float Elbow { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.9f. Min value = 0.0f. Max value = 4.0f.

ElbowAngleOnContact

On contact with upperbody the desired elbow angle is set to at least this value.

Declaration

public float ElbowAngleOnContact { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.9f. Min value = 0.0f. Max value = 3.0f.

HandsDelayMax

If bracing with 2 hands delay one hand by at most this amount of time to introduce some asymmetry.

Declaration

public float HandsDelayMax { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.7f. Min value = 0.0f. Max value = 3.0f.

HandsDelayMin

If bracing with 2 hands delay one hand by at least this amount of time to introduce some asymmetry.

Declaration

public float HandsDelayMin { set; }

Property Value

Type	Description
Single

Remarks

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

HeadLookAtVelProb

Probability [0-1] that headLook will be looking in the direction of velocity when stepping.

Declaration

public float HeadLookAtVelProb { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 1.0f.

HeadLookInstanceIndex

Level index of thing to look at.

Declaration

public int HeadLookInstanceIndex { set; }

Property Value

Type	Description
Int32

Remarks

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

HeadLookPos

Position of thing to look at.

Declaration

public Vector3 HeadLookPos { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f).

HipL2ArmL2

Mmmmdrunk = 0.2 multiplier of hip lean2 (star jump) to give shoulder lean2 (flapping).

Declaration

public float HipL2ArmL2 { set; }

Property Value

Type	Description
Single

Remarks

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

MinBraceTime

Minimum bracing time so the character doesn't look twitchy.

Declaration

public float MinBraceTime { set; }

Property Value

Type	Description
Single

Remarks

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

MoveAmount

Amount of leanForce applied away from pusher.

Declaration

public float MoveAmount { set; }

Property Value

Type	Description
Single

Remarks

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

MoveRadius

If -ve don't move away from pusher unless moveWhenBracing is true and braceDistance GT 0.0f. if the pusher is closer than moveRadius then move away from it.

Declaration

public float MoveRadius { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 2.0f.

MoveWhenBracing

Only move away from pusher when bracing against pusher.

Declaration

public bool MoveWhenBracing { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ReachAbsorbtionTime

Larger values and he absorbs the impact more.

Declaration

public float ReachAbsorbtionTime { set; }

Property Value

Type	Description
Single

Remarks

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

ReturningToBalanceArmsOut

Range 0:1 0 = don't raise arms if returning to upright position, 0.x = 0.x*raise arms based on angvel and 'angle' settings, 1 = raise arms based on angvel and 'angle' settings.

Declaration

public float ReturningToBalanceArmsOut { set; }

Property Value

Type	Description
Single

Remarks

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

Shoulder

How much the shoulder(lean1) swings based on the leg movement.

Declaration

public float Shoulder { set; }

Property Value

Type	Description
Single

Remarks

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

ShoulderL1

Mmmmdrunk 1.1 shoulder lean1 offset (+ve frankenstein).

Declaration

public float ShoulderL1 { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -1.0f. Max value = 2.0f.

ShoulderL2

Mmmmdrunk = 0.7 shoulder lean2 offset.

Declaration

public float ShoulderL2 { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.5f. Min value = -3.0f. Max value = 3.0f.

ShoulderTwist

Mmmmdrunk = 0.0 shoulder twist.

Declaration

public float ShoulderTwist { set; }

Property Value

Type	Description
Single

Remarks

Default value = -0.4f. Min value = -3.0f. Max value = 3.0f.

SideSomersaultAngle

Amount of side somersault 'angle' before sideSomersault is used for ArmsOut. Unless drunk - DO NOT EXCEED 0.8.

Declaration

public float SideSomersaultAngle { set; }

Property Value

Type	Description
Single

Remarks

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

SideSomersaultAngleThreshold

Declaration

public float SideSomersaultAngleThreshold { set; }

Property Value

Type	Description
Single

Remarks

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

SomersaultAngle

Multiplier of the somersault 'angle' (lean forward/back) for arms out (lean2).

Declaration

public float SomersaultAngle { set; }

Property Value

Type	Description
Single

Remarks

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

SomersaultAngleThreshold

Amount of somersault 'angle' before m_somersaultAngle is used for ArmsOut. Unless drunk - DO NOT EXCEED 0.8.

Declaration

public float SomersaultAngleThreshold { set; }

Property Value

Type	Description
Single

Remarks

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

SpineDamping

Declaration

public float SpineDamping { set; }

Property Value

Type	Description
Single

Remarks

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

SpineStiffness

Declaration

public float SpineStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

TargetPredictionTime

Time expected to get arms up from idle.

Declaration

public float TargetPredictionTime { set; }

Property Value

Type	Description
Single

Remarks

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

TimeToBackwardsBrace

Time before arm brace kicks in when hit from behind.

Declaration

public float TimeToBackwardsBrace { set; }

Property Value

Type	Description
Single

Remarks

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

Turn2TargetProb

Weighted probability of turning towards headLook target. This is one of six turn type weights.

Declaration

public float Turn2TargetProb { set; }

Property Value

Type	Description
Single

Remarks

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

Turn2VelProb

Weighted probability of turning towards velocity. This is one of six turn type weights.

Declaration

public float Turn2VelProb { set; }

Property Value

Type	Description
Single

Remarks

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

TurnAwayProb

Weighted probability of turning away from headLook target. This is one of six turn type weights.

Declaration

public float TurnAwayProb { set; }

Property Value

Type	Description
Single

Remarks

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

TurnLeftProb

Weighted probability of turning left. This is one of six turn type weights.

Declaration

public float TurnLeftProb { set; }

Property Value

Type	Description
Single

Remarks

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

TurnOffProb

Weighted probability that turn will be off. This is one of six turn type weights.

Declaration

public float TurnOffProb { set; }

Property Value

Type	Description
Single

Remarks

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

TurnRightProb

Weighted probability of turning right. This is one of six turn type weights.

Declaration

public float TurnRightProb { set; }

Property Value

Type	Description
Single

Remarks

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

TurnWithBumpRadius

0.9 is a sensible value. If pusher within this distance then turn to get out of the way of the pusher.

Declaration

public float TurnWithBumpRadius { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

UseBodyTurn

Declaration

public bool UseBodyTurn { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

UseHeadLook

Enable and provide a look-at target to make the character's head turn to face it while balancing.

Declaration

public bool UseHeadLook { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.