Class OnFireHelper

Inheritance

Object

CustomHelper

OnFireHelper

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

Constructors

OnFireHelper(Ped)

Creates a new Instance of the OnFireHelper for sending a OnFire Message to a given Ped.

Declaration

public OnFireHelper(Ped ped)

Parameters

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

Properties

ArmsPoseWritheBlend

Blend the bodyWrithe arms with the current desired pose from on fire behavior when character is on the floor.

Declaration

public float ArmsPoseWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

ArmsWindmillWritheBlend

Blend armsWindmill with the bodyWrithe arms when character is upright.

Declaration

public float ArmsWindmillWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

LegsPoseWritheBlend

Blend the bodyWrithe legs with the current desired pose from on fire behavior when character is on the floor.

Declaration

public float LegsPoseWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

LegsStumbleWritheBlend

Blend legs stumble with the bodyWrithe legs when character is upright.

Declaration

public float LegsStumbleWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

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.

Declaration

public float MaxRollOverTime { set; }

Property Value

Type	Description
Single

Remarks

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

PredictTime

Character pose depends on character facing direction that is evaluated from its COMTM orientation. Set this value to 0 to use no orientation prediction i.e. current character COMTM orientation will be used to determine character facing direction and finally the pose bodyWrithe is blending to. Set this value to GT 0 to predict character COMTM orientation this amount of time in seconds to the future.

Declaration

public float PredictTime { set; }

Property Value

Type	Description
Single

Remarks

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

RollOverFlag

Flag to set bodyWrithe trying to rollOver.

Declaration

public bool RollOverFlag { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

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.

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 by bodyWrithe. Torque magnitude is calculated with the following formula: m_rollOverDirectionrollOverPhaserollTorqueScale.

Declaration

public float RollTorqueScale { set; }

Property Value

Type	Description
Single

Remarks

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

SpinePoseWritheBlend

Blend the bodyWrithe back with the current desired pose from on fire behavior when character is on the floor.

Declaration

public float SpinePoseWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

SpineStumbleWritheBlend

Blend spine stumble with the bodyWrithe spine when character is upright.

Declaration

public float SpineStumbleWritheBlend { set; }

Property Value

Type	Description
Single

Remarks

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

StaggerLeanRate

How quickly the character leans hips when staggering.

Declaration

public float StaggerLeanRate { set; }

Property Value

Type	Description
Single

Remarks

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

StaggerTime

Max time for stumbling around before falling to ground.

Declaration

public float StaggerTime { set; }

Property Value

Type	Description
Single

Remarks

Default value = 2.5f. Min value = 0.0f. Max value = 30.0f.

StumbleMaxLeanBack

Max the character leans hips back when staggering.

Declaration

public float StumbleMaxLeanBack { set; }

Property Value

Type	Description
Single

Remarks

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

StumbleMaxLeanForward

Max the character leans hips forwards when staggering.

Declaration

public float StumbleMaxLeanForward { set; }

Property Value

Type	Description
Single

Remarks

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