Class YankedHelper

Inheritance

Object

CustomHelper

YankedHelper

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

Constructors

YankedHelper(Ped)

Creates a new Instance of the YankedHelper for sending a Yanked Message to a given Ped.

Declaration

public YankedHelper(Ped ped)

Parameters

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

Properties

ArmDamping

Sets damping value for the arms when upright.

Declaration

public float ArmDamping { set; }

Property Value

Type	Description
Single

Remarks

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

ArmDampingStart

Arm damping 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 when upright.

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

ArmStiffnessStart

Arm stiffness 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.

ComVelRDSThresh

For handsAndKnees catchfall ONLY: comVel above which rollDownstairs will start.

Declaration

public float ComVelRDSThresh { set; }

Property Value

Type	Description
Single

Remarks

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

FootFriction

Foot friction when standing/stepping. 0.5 gives a good slide sometimes.

Declaration

public float FootFriction { set; }

Property Value

Type	Description
Single

Remarks

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

GroundArmDamping

Arm Damping when on the ground.

Declaration

public float GroundArmDamping { set; }

Property Value

Type	Description
Single

Remarks

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

GroundArmStiffness

Arm Stiffness when on the ground.

Declaration

public float GroundArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

GroundFriction

Friction multiplier on body parts when on ground. Character can look too slidy with groundFriction = 1. Higher values give a more jerky reaction but this seems timestep dependent especially for dragged by the feet.

Declaration

public float GroundFriction { set; }

Property Value

Type	Description
Single

Remarks

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

GroundLegDamping

Leg Damping when on the ground.

Declaration

public float GroundLegDamping { set; }

Property Value

Type	Description
Single

Remarks

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

GroundLegStiffness

Leg Stiffness when on the ground.

Declaration

public float GroundLegStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

GroundSpineDamping

Spine Damping when on the ground.

Declaration

public float GroundSpineDamping { set; }

Property Value

Type	Description
Single

Remarks

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

GroundSpineStiffness

Spine Stiffness when on the ground.

Declaration

public float GroundSpineStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 14.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).

HipAmplitude

Amount of hip movement.

Declaration

public float HipAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

HipPitchBack

Amount to bend backwards at the hips (+ve backwards, -ve forwards). Behavior switches between hipPitchForward and hipPitchBack.

Declaration

public float HipPitchBack { set; }

Property Value

Type	Description
Single

Remarks

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

HipPitchForward

Amount to bend forward at the hips (+ve forward, -ve backwards). Behavior switches between hipPitchForward and hipPitchBack.

Declaration

public float HipPitchForward { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.6f. Min value = -1.3f. Max value = 1.3f.

HulaPeriod

0.25 A complete wiggle will take 4*hulaPeriod.

Declaration

public float HulaPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

LowerBodyStiffness

LowerBodyStiffness should be 12.

Declaration

public float LowerBodyStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 12.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.

MaxRelaxPeriod

Wriggle relaxes for a maximum of maxRelaxPeriod (if it is negative it is a multiplier on the time previously spent wriggling).

Declaration

public float MaxRelaxPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

MinRelaxPeriod

Wriggle relaxes for a minimum of minRelaxPeriod (if it is negative it is a multiplier on the time previously spent wriggling).

Declaration

public float MinRelaxPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

PerStepReduction

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

Declaration

public float PerStepReduction { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.5f. Min value = 0.0f. Max value = 10.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.1f. 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.

RollHelp

Amount of cheat torque applied to turn the character over.

Declaration

public float RollHelp { set; }

Property Value

Type	Description
Single

Remarks

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

SpineAmplitude

Amount of spine movement.

Declaration

public float SpineAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

SpineBend

Bend/Twist the spine amount.

Declaration

public float SpineBend { set; }

Property Value

Type	Description
Single

Remarks

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

SpineDamping

Spine damping when upright.

Declaration

public float SpineDamping { set; }

Property Value

Type	Description
Single

Remarks

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

SpineDampingStart

Spine damping 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

Spine stiffness when upright.

Declaration

public float SpineStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

SpineStiffnessStart

Spine stiffness 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.

StepsTillStartEnd

Steps taken before lowerBodyStiffness starts ramping down.

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.4f. Min value = 0.0f. Max value = 2.0f.

TimeStartEnd

Time from start of behavior before lowerBodyStiffness starts ramping down by perStepReduction1.

Declaration

public float TimeStartEnd { set; }

Property Value

Type	Description
Single

Remarks

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

TurnThresholdMax

Max angle at which the turn with toggle to the other direction (actual toggle angle is chosen randomly in range min to max). If it is 1 then it will never toggle. If negative then no turn is applied.

Declaration

public float TurnThresholdMax { set; }

Property Value

Type	Description
Single

Remarks

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

TurnThresholdMin

Min angle at which the turn with toggle to the other direction (actual toggle angle is chosen randomly in range min to max). If it is 1 then it will never toggle. If negative then no turn is applied.

Declaration

public float TurnThresholdMin { set; }

Property Value

Type	Description
Single

Remarks

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

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.