Class BodyWritheHelper

Inheritance

Object

CustomHelper

BodyWritheHelper

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

Constructors

BodyWritheHelper(Ped)

Creates a new Instance of the BodyWritheHelper for sending a BodyWrithe Message to a given Ped.

Declaration

public BodyWritheHelper(Ped ped)

Parameters

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

Properties

ApplyStiffness

Use writhe stiffnesses if true. If false don't set any stiffnesses.

Declaration

public bool ApplyStiffness { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

ArmAmplitude

Declaration

public float ArmAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

ArmDamping

Damping amount, less is underdamped.

Declaration

public float ArmDamping { set; }

Property Value

Type	Description
Single

Remarks

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

ArmPeriod

Controls how fast the writhe is executed, smaller values make faster motions.

Declaration

public float ArmPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

ArmStiffness

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

BackAmplitude

Scales the amount of writhe. 0 = no writhe.

Declaration

public float BackAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

BackDamping

Damping amount, less is underdamped.

Declaration

public float BackDamping { set; }

Property Value

Type	Description
Single

Remarks

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

BackPeriod

Controls how fast the writhe is executed, smaller values make faster motions.

Declaration

public float BackPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

BackStiffness

Declaration

public float BackStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

BlendArms

Blend the writhe arms with the current desired arms (0=don't apply any writhe, 1=only writhe).

Declaration

public float BlendArms { set; }

Property Value

Type	Description
Single

Remarks

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

BlendBack

Blend the writhe spine and neck with the current desired (0=don't apply any writhe, 1=only writhe).

Declaration

public float BlendBack { set; }

Property Value

Type	Description
Single

Remarks

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

BlendLegs

Blend the writhe legs with the current desired legs (0=don't apply any writhe, 1=only writhe).

Declaration

public float BlendLegs { set; }

Property Value

Type	Description
Single

Remarks

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

ElbowAmplitude

Declaration

public float ElbowAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

KneeAmplitude

Declaration

public float KneeAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

Lean1BlendFactor

Shoulder desired lean1 with shoulderLean1 angle blend factor. Set it to 0 to use original shoulder withe desired lean1 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float Lean1BlendFactor { set; }

Property Value

Type	Description
Single

Remarks

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

Lean2BlendFactor

Shoulder desired lean2 with shoulderLean2 angle blend factor. Set it to 0 to use original shoulder withe desired lean2 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float Lean2BlendFactor { set; }

Property Value

Type	Description
Single

Remarks

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

LegAmplitude

Scales the amount of writhe. 0 = no writhe.

Declaration

public float LegAmplitude { set; }

Property Value

Type	Description
Single

Remarks

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

LegDamping

Damping amount, less is underdamped.

Declaration

public float LegDamping { set; }

Property Value

Type	Description
Single

Remarks

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

LegPeriod

Controls how fast the writhe is executed, smaller values make faster motions.

Declaration

public float LegPeriod { set; }

Property Value

Type	Description
Single

Remarks

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

LegStiffness

The stiffness of the character will determine how 'determined' a writhe this is - high values will make him thrash about wildly.

Declaration

public float LegStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

Mask

Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see Active Pose notes for possible values).

Declaration

public string Mask { set; }

Property Value

Type	Description
String

Remarks

Default value = "fb".

MaxRollOverTime

Rolling torque is ramped down over time. At this time in seconds torque value converges to zero. Use this parameter to restrict time the character is rolling. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float MaxRollOverTime { set; }

Property Value

Type	Description
Single

Remarks

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

OnFire

Extra shoulderBlend. Rolling:one way only, maxRollOverTime, rollOverRadius, doesn't reduce arm stiffness to help rolling. No shoulder twist.

Declaration

public bool OnFire { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

RollOverFlag

Flag to set trying to rollOver.

Declaration

public bool RollOverFlag { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

RollOverRadius

Rolling torque is ramped down with distance measured from position where character hit the ground and started rolling. At this distance in meters torque value converges to zero. Use this parameter to restrict distance the character travels due to rolling. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float RollOverRadius { set; }

Property Value

Type	Description
Single

Remarks

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

RollTorqueScale

Scale rolling torque that is applied to character spine.

Declaration

public float RollTorqueScale { set; }

Property Value

Type	Description
Single

Remarks

Default value = 150.0f. Min value = 0.0f. Max value = 300.0f.

ShoulderLean1

Blend writhe shoulder desired lean1 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float ShoulderLean1 { set; }

Property Value

Type	Description
Single

Remarks

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

ShoulderLean2

Blend writhe shoulder desired lean2 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.

Declaration

public float ShoulderLean2 { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.4f. Min value = 0.0f. Max value = 6.3f.