Class ShotFallToKneesHelper

Configure the fall to knees shot.

Inheritance

Object

CustomHelper

ShotFallToKneesHelper

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

Constructors

ShotFallToKneesHelper(Ped)

Creates a new Instance of the ShotFallToKneesHelper for sending a ShotFallToKnees Message to a given Ped.

Declaration

public ShotFallToKneesHelper(Ped ped)

Parameters

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

Remarks

Configure the fall to knees shot.

Properties

FallToKnees

Type of reaction.

Declaration

public bool FallToKnees { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

FtkAlwaysChangeFall

Always change fall behavior. If false only change when falling forward.

Declaration

public bool FtkAlwaysChangeFall { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

FtkBalanceAbortThreshold

When the character gives up and goes into a fall.

Declaration

public float FtkBalanceAbortThreshold { set; }

Property Value

Type	Description
Single

Remarks

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

FtkBalanceTime

How long the balancer runs for before fallToKnees starts.

Declaration

public float FtkBalanceTime { set; }

Property Value

Type	Description
Single

Remarks

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

FtkBendRate

Rate at which the legs are bent to go from standing to on knees.

Declaration

public float FtkBendRate { set; }

Property Value

Type	Description
Single

Remarks

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

FtkFailMustCollide

The upper body of the character must be colliding and other failure conditions met to fail.

Declaration

public bool FtkFailMustCollide { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

FtkFallBelowStab

Balancer instability below which the character starts to bend legs even if it isn't going to fall on to it's knees (i.e. if going backwards). 0.3 almost ensures a fall to knees but means the character will keep stepping backward until it slows down enough.

Declaration

public float FtkFallBelowStab { set; }

Property Value

Type	Description
Single

Remarks

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

FtkFricMult

Multiplier on the reduction of friction for the feet based on angle away from horizontal - helps the character fall to knees quicker.

Declaration

public float FtkFricMult { set; }

Property Value

Type	Description
Single

Remarks

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

FtkHelperForce

Hip helper force magnitude - to help character lean over balance point of line between toes.

Declaration

public float FtkHelperForce { set; }

Property Value

Type	Description
Single

Remarks

Default value = 200.0f. Min value = 0.0f. Max value = 2000.0f.

FtkHelperForceOnSpine

Helper force applied to spine3 as well.

Declaration

public bool FtkHelperForceOnSpine { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

FtkHipAngleFall

Apply this hip angle when the character starts to fall backwards when on knees.

Declaration

public float FtkHipAngleFall { set; }

Property Value

Type	Description
Single

Remarks

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

FtkHipBlend

Blend from current hip to balancing on knees hip angle.

Declaration

public float FtkHipBlend { set; }

Property Value

Type	Description
Single

Remarks

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

FtkImpactLooseness

Looseness (muscleStiffness = 1.01f - m_parameters.ftkImpactLooseness) applied to upperBody on knee impacts.

Declaration

public float FtkImpactLooseness { set; }

Property Value

Type	Description
Single

Remarks

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

FtkImpactLoosenessTime

Time that looseness is applied after knee impacts.

Declaration

public float FtkImpactLoosenessTime { set; }

Property Value

Type	Description
Single

Remarks

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

FtkKneeSpin

When on knees allow some spinning of the character. If false then the balancers' footSlipCompensation remains on and tends to keep the character facing the same way as when it was balancing.

Declaration

public bool FtkKneeSpin { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

FtkLeanHelp

Help balancer lean amount - to help character lean over balance point of line between toes. Half of this is also applied as hipLean.

Declaration

public float FtkLeanHelp { set; }

Property Value

Type	Description
Single

Remarks

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

FtkLungeProb

Probability that a lunge reaction will be allowed.

Declaration

public float FtkLungeProb { set; }

Property Value

Type	Description
Single

Remarks

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

FtkOnKneesArmType

Type of arm response when on knees falling forward 0=useFallArms (from RollDownstairs or catchFall), 1= armsIn, 2=armsOut.

Declaration

public int FtkOnKneesArmType { set; }

Property Value

Type	Description
Int32

Remarks

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

FtkPitchBackwards

Hip pitch applied (+ve forward, -ve backwards) if character is falling backwards on way down to it's knees.

Declaration

public float FtkPitchBackwards { set; }

Property Value

Type	Description
Single

Remarks

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

FtkPitchForwards

Hip pitch applied (+ve forward, -ve backwards) if character is falling forwards on way down to it's knees.

Declaration

public float FtkPitchForwards { set; }

Property Value

Type	Description
Single

Remarks

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

FtkReachForWound

True = Keep reaching for wound regardless of fall/onground state. false = respect the shotConfigureArms params: reachFalling, reachFallingWithOneHand, reachOnFloor.

Declaration

public bool FtkReachForWound { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

FtkReleasePointGun

Override the pointGun when knees hit.

Declaration

public bool FtkReleasePointGun { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

FtkReleaseReachForWound

Release the reachForWound this amount of time after the knees have hit. If LT 0.0 then keep reaching for wound regardless of fall/onground state.

Declaration

public float FtkReleaseReachForWound { set; }

Property Value

Type	Description
Single

Remarks

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

FtkSpineBend

Bend applied to spine when falling from knees. (+ve forward - try -0.1) (only if rds called).

Declaration

public float FtkSpineBend { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -0.2f. Max value = 0.3f.

FtkStiffSpine

Stiffen spine when falling from knees (only if rds called).

Declaration

public bool FtkStiffSpine { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.