Class BodyRollUpHelper

Inheritance

Object

CustomHelper

BodyRollUpHelper

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

Constructors

BodyRollUpHelper(Ped)

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

Declaration

public BodyRollUpHelper(Ped ped)

Parameters

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

Properties

ApplyMinMaxFriction

Controls whether or not behavior enforces min/max friction.

Declaration

public bool ApplyMinMaxFriction { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

ArmReachAmount

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

Declaration

public float ArmReachAmount { set; }

Property Value

Type	Description
Single

Remarks

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

AsymmetricalLegs

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.

Declaration

public float AsymmetricalLegs { set; }

Property Value

Type	Description
Single

Remarks

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

LegPush

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

Declaration

public float LegPush { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -1.0f. Max value = 2.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".

NoRollTimeBeforeSuccess

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

Declaration

public float NoRollTimeBeforeSuccess { set; }

Property Value

Type	Description
Single

Remarks

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

RollVelForSuccess

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

Declaration

public float RollVelForSuccess { set; }

Property Value

Type	Description
Single

Remarks

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

RollVelLinearContribution

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

Declaration

public float RollVelLinearContribution { set; }

Property Value

Type	Description
Single

Remarks

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

Stiffness

Stiffness of whole body.

Declaration

public float Stiffness { set; }

Property Value

Type	Description
Single

Remarks

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

UseArmToSlowDown

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

Declaration

public float UseArmToSlowDown { set; }

Property Value

Type	Description
Single

Remarks

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

VelocityOffset

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

Declaration

public float VelocityOffset { set; }

Property Value

Type	Description
Single

Remarks

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

VelocityScale

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

Declaration

public float VelocityScale { set; }

Property Value

Type	Description
Single

Remarks

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