Class StaggerFallHelper

Inheritance

Object

CustomHelper

StaggerFallHelper

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

Constructors

StaggerFallHelper(Ped)

Creates a new Instance of the StaggerFallHelper for sending a StaggerFall Message to a given Ped.

Declaration

public StaggerFallHelper(Ped ped)

Parameters

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

Properties

AlwaysBendForwards

Bend forwards at the hip (hipBendMult) whether moving backwards or forwards.

Declaration

public bool AlwaysBendForwards { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ArmDamping

Sets damping value for the arms.

Declaration

public float ArmDamping { set; }

Property Value

Type	Description
Single

Remarks

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

ArmDampingStart

ArmDamping during the yanked timescale i.e. timeAtStartValues.

Declaration

public float ArmDampingStart { set; }

Property Value

Type	Description
Single

Remarks

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

ArmStiffness

Stiffness of arms. Catch_fall's stiffness scales with this value, but has default values when this is default.

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

ArmStiffnessStart

ArmStiffness during the yanked timescale i.e. timeAtStartValues.

Declaration

public float ArmStiffnessStart { set; }

Property Value

Type	Description
Single

Remarks

Default value = 3.0f. Min value = 0.0f. Max value = 16.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).

HipBendMult

HipBend scaled with velocity.

Declaration

public float HipBendMult { set; }

Property Value

Type	Description
Single

Remarks

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

Lean2multB

Lean of spine to side in side velocity direction when going backwards.

Declaration

public float Lean2multB { set; }

Property Value

Type	Description
Single

Remarks

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

Lean2multF

Lean of spine to side in side velocity direction when going forwards.

Declaration

public float Lean2multF { set; }

Property Value

Type	Description
Single

Remarks

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

LeanHipsMaxB

Max of leanInDirectionHips magnitude when going backwards.

Declaration

public float LeanHipsMaxB { set; }

Property Value

Type	Description
Single

Remarks

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

LeanHipsMaxF

Max of leanInDirectionHips magnitude when going forwards.

Declaration

public float LeanHipsMaxF { set; }

Property Value

Type	Description
Single

Remarks

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

LeanInDirMaxB

Max of leanInDirection magnitude when going backwards.

Declaration

public float LeanInDirMaxB { set; }

Property Value

Type	Description
Single

Remarks

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

LeanInDirMaxF

Max of leanInDirection magnitude when going forwards.

Declaration

public float LeanInDirMaxF { set; }

Property Value

Type	Description
Single

Remarks

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

LeanInDirRate

LeanInDirection will be increased from 0 to leanInDirMax linearly at this rate.

Declaration

public float LeanInDirRate { set; }

Property Value

Type	Description
Single

Remarks

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

LowerBodyStiffness

LowerBodyStiffness should be 12.

Declaration

public float LowerBodyStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 13.0f. Min value = 0.0f. Max value = 16.0f.

LowerBodyStiffnessEnd

LowerBodyStiffness at end.

Declaration

public float LowerBodyStiffnessEnd { set; }

Property Value

Type	Description
Single

Remarks

Default value = 8.0f. Min value = 0.0f. Max value = 16.0f.

MaxPushoffVel

Stance leg will only pushOff to increase momentum if the vertical hip velocity is less than this value. 0.4 seems like a good value. The higher it is the less this functionality is applied. If it is very low or negative this can stop the pushOff altogether.

Declaration

public float MaxPushoffVel { set; }

Property Value

Type	Description
Single

Remarks

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

PerStepReduction1

LowerBody stiffness will be reduced every step to make the character fallover.

Declaration

public float PerStepReduction1 { set; }

Property Value

Type	Description
Single

Remarks

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

PredictionTime

Amount of time (seconds) into the future that the character tries to step to. Bigger values try to recover with fewer, bigger steps. Smaller values recover with smaller steps, and generally recover less.

Declaration

public float PredictionTime { set; }

Property Value

Type	Description
Single

Remarks

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

PushOffDist

Amount stance foot is behind com in the direction of velocity before the leg tries to pushOff to increase momentum. Increase to lower the probability of the pushOff making the character bouncy.

Declaration

public float PushOffDist { set; }

Property Value

Type	Description
Single

Remarks

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

RampTimeFromStartValues

Time spent ramping from Start to end values for arms and spine stiffness and damping i.e. for whiplash effect (occurs after timeAtStartValues).

Declaration

public float RampTimeFromStartValues { set; }

Property Value

Type	Description
Single

Remarks

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

RampTimeToEndValues

Time spent ramping from lowerBodyStiffness to lowerBodyStiffnessEnd.

Declaration

public float RampTimeToEndValues { set; }

Property Value

Type	Description
Single

Remarks

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

SpineBendMult

Spine bend scaled with velocity.

Declaration

public float SpineBendMult { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.4f. Min value = -10.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.

SpineDampingStart

SpineDamping during the yanked timescale i.e. timeAtStartValues.

Declaration

public float SpineDampingStart { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.1f. 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 = 0.0f. Max value = 16.0f.

SpineStiffnessStart

SpineStiffness during the yanked timescale i.e. timeAtStartValues.

Declaration

public float SpineStiffnessStart { set; }

Property Value

Type	Description
Single

Remarks

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

StaggerStepProb

Probability per step of time spent in a stagger step.

Declaration

public float StaggerStepProb { set; }

Property Value

Type	Description
Single

Remarks

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

StepsTillStartEnd

Steps taken before lowerBodyStiffness starts ramping down by perStepReduction1.

Declaration

public int StepsTillStartEnd { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 2. Min value = 0. Max value = 100.

TimeAtStartValues

Time spent with Start values for arms and spine stiffness and damping i.e. for whiplash effect.

Declaration

public float TimeAtStartValues { set; }

Property Value

Type	Description
Single

Remarks

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

TimeStartEnd

Time from start of behavior before lowerBodyStiffness starts ramping down for rampTimeToEndValues to endValues.

Declaration

public float TimeStartEnd { set; }

Property Value

Type	Description
Single

Remarks

Default value = 100.0f. Min value = 0.0f. Max value = 100.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.0f. 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 = 1.0f. 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.0f. 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.0f. 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.0f. 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.0f. Min value = 0.0f. Max value = 1.0f.

UpperBodyReaction

Enable upper body reaction i.e. blindBrace and armswindmill.

Declaration

public bool UpperBodyReaction { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

UseBodyTurn

Enable and provide a positive bodyTurnTimeout and provide a look-at target to make the character turn to face it while balancing.

Declaration

public bool UseBodyTurn { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseHeadLook

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

Declaration

public bool UseHeadLook { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.