Class RollDownStairsHelper

Inheritance

Object

CustomHelper

RollDownStairsHelper

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

Constructors

RollDownStairsHelper(Ped)

Creates a new Instance of the RollDownStairsHelper for sending a RollDownStairs Message to a given Ped.

Declaration

public RollDownStairsHelper(Ped ped)

Parameters

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

Properties

AirborneReduction

Ordinarily keep at 0.85. Make this lower if you want spinning in the air.

Declaration

public float AirborneReduction { set; }

Property Value

Type	Description
Single

Remarks

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

ApplyFoetalToLegs

If true, use rollup for upper body and a kind of foetal behavior for legs.

Declaration

public bool ApplyFoetalToLegs { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ApplyHelPerTorqueToAlign

Apply torque to align the body orthogonally to the direction of the roll.

Declaration

public bool ApplyHelPerTorqueToAlign { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ApplyMinMaxFriction

Pass-through to Roll Up. Controls whether or not behavior enforces min/max friction.

Declaration

public bool ApplyMinMaxFriction { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

ApplyNewRollingCheatingTorques

If true will use the new way to apply cheating torques (like in fallOverWall), otherwise will use the old way.

Declaration

public bool ApplyNewRollingCheatingTorques { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ArmReachLength

The length that the arm reaches and so how much it straightens.

Declaration

public float ArmReachLength { set; }

Property Value

Type	Description
Single

Remarks

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

CustomRollDir

Pass in a custom direction in to have the character try and roll in that direction.

Declaration

public Vector3 CustomRollDir { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 1.0f. Max value = 1.0f.

Damping

Effector Damping.

Declaration

public float Damping { set; }

Property Value

Type	Description
Single

Remarks

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

DelayToAlignBody

Only used if applyHelPerTorqueToAlign defined to true : delay to start to apply torques.

Declaration

public float DelayToAlignBody { set; }

Property Value

Type	Description
Single

Remarks

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

Forcemag

Helper force strength. Do not go above 1 for a rollDownStairs/roll along ground reaction.

Declaration

public float Forcemag { set; }

Property Value

Type	Description
Single

Remarks

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

LimitSpinReduction

Scale zAxisSpinReduction back when rotating end-over-end (somersault) to give the body a chance to align with the axis of rotation.

Declaration

public bool LimitSpinReduction { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

M_armReachAmount

How much the character reaches with his arms to brace against the ground.

Declaration

public float M_armReachAmount { set; }

Property Value

Type	Description
Single

Remarks

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

M_legPush

Amount that the legs push outwards when tumbling.

Declaration

public float M_legPush { set; }

Property Value

Type	Description
Single

Remarks

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

M_useArmToSlowDown

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

Declaration

public float M_useArmToSlowDown { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.9f. Min value = -3.0f. Max value = 3.0f.

MagOfTorqueToAlign

Only used if applyHelPerTorqueToAlign defined to true : magnitude of the torque to align orthogonally the body.

Declaration

public float MagOfTorqueToAlign { set; }

Property Value

Type	Description
Single

Remarks

Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.

MagOfTorqueToRoll

Only used if applyNewRollingCheatingTorques defined to true : magnitude of the torque to roll down the stairs.

Declaration

public float MagOfTorqueToRoll { set; }

Property Value

Type	Description
Single

Remarks

Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.

MaxAngVel

Only used if applyNewRollingCheatingTorques defined to true : maximal angular velocity of the roll to apply cheating torque.

Declaration

public float MaxAngVel { set; }

Property Value

Type	Description
Single

Remarks

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

MaxAngVelAroundFrontwardAxis

Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : maximal angular velocity around frontward axis of the pelvis to apply cheating torques.

Declaration

public float MaxAngVelAroundFrontwardAxis { set; }

Property Value

Type	Description
Single

Remarks

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

MinAngVel

Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : minimal angular velocity of the roll to apply cheating torques.

Declaration

public float MinAngVel { set; }

Property Value

Type	Description
Single

Remarks

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

MovementLegsInFoetalPosition

Only used if applyFoetalToLegs = true : define the variation of angles for the joints of the legs.

Declaration

public float MovementLegsInFoetalPosition { set; }

Property Value

Type	Description
Single

Remarks

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

OnlyApplyHelperForces

Don't use rollup if true.

Declaration

public bool OnlyApplyHelperForces { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

SpinWhenInAir

Applied cheat forces to spin the character when in the air, the forces are 40% of the forces applied when touching the ground. Be careful little bunny rabbits, the character could spin unnaturally in the air.

Declaration

public bool SpinWhenInAir { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

Stiffness

Effector Stiffness. Value feeds through to rollUp directly.

Declaration

public float Stiffness { set; }

Property Value

Type	Description
Single

Remarks

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

StiffnessDecayTarget

The target linear velocity used to start the rolling.

Declaration

public float StiffnessDecayTarget { set; }

Property Value

Type	Description
Single

Remarks

Default value = 9.0f. Min value = 0.0f. Max value = 20.0f.

StiffnessDecayTime

Time, in seconds, to decay stiffness down to the stiffnessDecayTarget value (or -1 to disable).

Declaration

public float StiffnessDecayTime { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

TargetLinearVelocity

Helper torques are applied to match the spin of the character to the max of targetLinearVelocity and COMVelMag.

Declaration

public float TargetLinearVelocity { set; }

Property Value

Type	Description
Single

Remarks

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

TargetLinearVelocityDecayTime

Time for the targetlinearVelocity to decay to zero.

Declaration

public float TargetLinearVelocityDecayTime { set; }

Property Value

Type	Description
Single

Remarks

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

TryToAvoidHeadButtingGround

Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.

Declaration

public bool TryToAvoidHeadButtingGround { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseCustomRollDir

Pass in true to use the customRollDir parameter.

Declaration

public bool UseCustomRollDir { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseRelativeVelocity

UseVelocityOfObjectBelow uses a relative velocity of the character to the object underneath.

Declaration

public bool UseRelativeVelocity { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseVelocityOfObjectBelow

Scale applied cheat forces/torques to (zero) if object underneath character has velocity greater than 1.f.

Declaration

public bool UseVelocityOfObjectBelow { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseZeroPose

Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.

Declaration

public bool UseZeroPose { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ZAxisSpinReduction

Tries to reduce the spin around the z axis. Scale 0 - 1.

Declaration

public float ZAxisSpinReduction { set; }

Property Value

Type	Description
Single

Remarks

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