Inheritance diagram for GTA.NaturalMotion.OnFireHelper:

Public Member Functions
	OnFireHelper (Ped ped)
	Creates a new Instance of the OnFireHelper for sending a OnFire Message to a given Ped. More...

Public Member Functions inherited from GTA.NaturalMotion.CustomHelper
void	Start ()
	Starts this Natural Motion behavior on the Ped that will loop until manually aborted. More...

void	Start (int duration)
	Starts this Natural Motion behavior on the Ped for a specified duration. More...

void	Stop ()
	Stops this Natural Motion behavior on the Ped. More...

void	SetArgument (string argName, bool value)
	Sets a Message argument to a bool value. More...

void	SetArgument (string argName, int value)
	Sets a Message argument to a int value. More...

void	SetArgument (string argName, float value)
	Sets a Message argument to a float value. More...

void	SetArgument (string argName, string value)
	Sets a Message argument to a string value. More...

void	SetArgument (string argName, Vector3 value)
	Sets a Message argument to a Vector3 value. More...

void	ResetArguments ()
	Resets all arguments to their default values. More...

override string	ToString ()
	Returns the internal message name. More...

Properties
float	StaggerTime `[set]`
	Max time for stumbling around before falling to ground. More...

float	StaggerLeanRate `[set]`
	How quickly the character leans hips when staggering. More...

float	StumbleMaxLeanBack `[set]`
	Max the character leans hips back when staggering. More...

float	StumbleMaxLeanForward `[set]`
	Max the character leans hips forwards when staggering. More...

float	ArmsWindmillWritheBlend `[set]`
	Blend armsWindmill with the bodyWrithe arms when character is upright. More...

float	SpineStumbleWritheBlend `[set]`
	Blend spine stumble with the bodyWrithe spine when character is upright. More...

float	LegsStumbleWritheBlend `[set]`
	Blend legs stumble with the bodyWrithe legs when character is upright. More...

float	ArmsPoseWritheBlend `[set]`
	Blend the bodyWrithe arms with the current desired pose from on fire behavior when character is on the floor. More...

float	SpinePoseWritheBlend `[set]`
	Blend the bodyWrithe back with the current desired pose from on fire behavior when character is on the floor. More...

float	LegsPoseWritheBlend `[set]`
	Blend the bodyWrithe legs with the current desired pose from on fire behavior when character is on the floor. More...

bool	RollOverFlag `[set]`
	Flag to set bodyWrithe trying to rollOver. More...

float	RollTorqueScale `[set]`
	Scale rolling torque that is applied to character spine by bodyWrithe. Torque magnitude is calculated with the following formula: m_rollOverDirectionrollOverPhaserollTorqueScale. More...

float	PredictTime `[set]`
	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. More...

float	MaxRollOverTime `[set]`
	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. More...

float	RollOverRadius `[set]`
	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. More...

Additional Inherited Members
Protected Member Functions inherited from GTA.NaturalMotion.CustomHelper
	CustomHelper (Ped target, string message)
	Creates a helper class for building Natural Motion messages to send to a given Ped. More...

Constructor & Destructor Documentation

◆ OnFireHelper()

GTA.NaturalMotion.OnFireHelper.OnFireHelper ( Ped ped )

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

Parameters

ped	The Ped to send the OnFire Message to.

Property Documentation

◆ ArmsPoseWritheBlend

float GTA.NaturalMotion.OnFireHelper.ArmsPoseWritheBlend

set

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

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

◆ ArmsWindmillWritheBlend

float GTA.NaturalMotion.OnFireHelper.ArmsWindmillWritheBlend

set

Blend armsWindmill with the bodyWrithe arms when character is upright.

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

◆ LegsPoseWritheBlend

float GTA.NaturalMotion.OnFireHelper.LegsPoseWritheBlend

set

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

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

◆ LegsStumbleWritheBlend

float GTA.NaturalMotion.OnFireHelper.LegsStumbleWritheBlend

set

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

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

◆ MaxRollOverTime

float GTA.NaturalMotion.OnFireHelper.MaxRollOverTime

set

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.

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

◆ PredictTime

float GTA.NaturalMotion.OnFireHelper.PredictTime

set

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.

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

◆ RollOverFlag

bool GTA.NaturalMotion.OnFireHelper.RollOverFlag

set

Flag to set bodyWrithe trying to rollOver.

Default value = True.

◆ RollOverRadius

float GTA.NaturalMotion.OnFireHelper.RollOverRadius

set

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.

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

◆ RollTorqueScale

float GTA.NaturalMotion.OnFireHelper.RollTorqueScale

set

Scale rolling torque that is applied to character spine by bodyWrithe. Torque magnitude is calculated with the following formula: m_rollOverDirection*rollOverPhase*rollTorqueScale.

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

◆ SpinePoseWritheBlend

float GTA.NaturalMotion.OnFireHelper.SpinePoseWritheBlend

set

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

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

◆ SpineStumbleWritheBlend

float GTA.NaturalMotion.OnFireHelper.SpineStumbleWritheBlend

set

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

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

◆ StaggerLeanRate

float GTA.NaturalMotion.OnFireHelper.StaggerLeanRate

set

How quickly the character leans hips when staggering.

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

◆ StaggerTime

float GTA.NaturalMotion.OnFireHelper.StaggerTime

set

Max time for stumbling around before falling to ground.

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

◆ StumbleMaxLeanBack

float GTA.NaturalMotion.OnFireHelper.StumbleMaxLeanBack

set

Max the character leans hips back when staggering.

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

◆ StumbleMaxLeanForward

float GTA.NaturalMotion.OnFireHelper.StumbleMaxLeanForward

set

Max the character leans hips forwards when staggering.

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

The documentation for this class was generated from the following file:

C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs

Public Member Functions

Properties

Additional Inherited Members