Inheritance diagram for GTA.NaturalMotion.BodyRollUpHelper:

Public Member Functions
	BodyRollUpHelper (Ped ped)
	Creates a new Instance of the BodyRollUpHelper for sending a BodyRollUp 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	Stiffness `[set]`
	Stiffness of whole body. More...

float	UseArmToSlowDown `[set]`
	The degree to which the character will try to stop a barrel roll with his arms. More...

float	ArmReachAmount `[set]`
	The likeliness of the character reaching for the ground with its arms. More...

string	Mask `[set]`
	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). More...

float	LegPush `[set]`
	Used to keep rolling down slope, 1 is full (kicks legs out when pointing upwards). More...

float	AsymmetricalLegs `[set]`
	0 is no leg asymmetry in 'foetal' position. greater than 0 a asymmetricalLegs-rand(30%), added/minus each joint of the legs in radians. Random number changes about once every roll. 0.4 gives a lot of asymmetry. More...

float	NoRollTimeBeforeSuccess `[set]`
	Time that roll velocity has to be lower than rollVelForSuccess, before success message is sent. More...

float	RollVelForSuccess `[set]`
	Lower threshold for roll velocity at which success message can be sent. More...

float	RollVelLinearContribution `[set]`
	Contribution of linear COM velocity to roll Velocity (if 0, roll velocity equal to COM angular velocity). More...

float	VelocityScale `[set]`
	Scales perceived body velocity. The higher this value gets, the more quickly the velocity measure saturates, resulting in a tighter roll at slower speeds. (NB: Set to 1 to match earlier behavior). More...

float	VelocityOffset `[set]`
	Offsets perceived body velocity. Increase to create larger "dead zone" around zero velocity where character will be less rolled. (NB: Reset to 0 to match earlier behavior). More...

bool	ApplyMinMaxFriction `[set]`
	Controls whether or not behavior enforces min/max friction. 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

◆ BodyRollUpHelper()

GTA.NaturalMotion.BodyRollUpHelper.BodyRollUpHelper ( Ped ped )

Creates a new Instance of the BodyRollUpHelper for sending a BodyRollUp Message to a given Ped.

Parameters

ped	The Ped to send the BodyRollUp Message to.

Property Documentation

◆ ApplyMinMaxFriction

bool GTA.NaturalMotion.BodyRollUpHelper.ApplyMinMaxFriction

set

Controls whether or not behavior enforces min/max friction.

Default value = True.

◆ ArmReachAmount

float GTA.NaturalMotion.BodyRollUpHelper.ArmReachAmount

set

The likeliness of the character reaching for the ground with its arms.

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

◆ AsymmetricalLegs

float GTA.NaturalMotion.BodyRollUpHelper.AsymmetricalLegs

set

0 is no leg asymmetry in 'foetal' position. greater than 0 a asymmetricalLegs-rand(30%), added/minus each joint of the legs in radians. Random number changes about once every roll. 0.4 gives a lot of asymmetry.

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

◆ LegPush

float GTA.NaturalMotion.BodyRollUpHelper.LegPush

set

Used to keep rolling down slope, 1 is full (kicks legs out when pointing upwards).

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

◆ Mask

string GTA.NaturalMotion.BodyRollUpHelper.Mask

set

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).

Default value = "fb".

◆ NoRollTimeBeforeSuccess

float GTA.NaturalMotion.BodyRollUpHelper.NoRollTimeBeforeSuccess

set

Time that roll velocity has to be lower than rollVelForSuccess, before success message is sent.

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

◆ RollVelForSuccess

float GTA.NaturalMotion.BodyRollUpHelper.RollVelForSuccess

set

Lower threshold for roll velocity at which success message can be sent.

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

◆ RollVelLinearContribution

float GTA.NaturalMotion.BodyRollUpHelper.RollVelLinearContribution

set

Contribution of linear COM velocity to roll Velocity (if 0, roll velocity equal to COM angular velocity).

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

◆ Stiffness

float GTA.NaturalMotion.BodyRollUpHelper.Stiffness

set

Stiffness of whole body.

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

◆ UseArmToSlowDown

float GTA.NaturalMotion.BodyRollUpHelper.UseArmToSlowDown

set

The degree to which the character will try to stop a barrel roll with his arms.

Default value = 1.3f. Min value = -2.0f. Max value = 3.0f.

◆ VelocityOffset

float GTA.NaturalMotion.BodyRollUpHelper.VelocityOffset

set

Offsets perceived body velocity. Increase to create larger "dead zone" around zero velocity where character will be less rolled. (NB: Reset to 0 to match earlier behavior).

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

◆ VelocityScale

float GTA.NaturalMotion.BodyRollUpHelper.VelocityScale

set

Scales perceived body velocity. The higher this value gets, the more quickly the velocity measure saturates, resulting in a tighter roll at slower speeds. (NB: Set to 1 to match earlier behavior).