Public Member Functions | |
| RollDownStairsHelper (Ped ped) | |
| Creates a new Instance of the RollDownStairsHelper for sending a RollDownStairs 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] |
| Effector Stiffness. Value feeds through to rollUp directly. More... | |
| float | Damping [set] |
| Effector Damping. More... | |
| float | Forcemag [set] |
| Helper force strength. Do not go above 1 for a rollDownStairs/roll along ground reaction. More... | |
| float | M_useArmToSlowDown [set] |
| The degree to which the character will try to stop a barrel roll with his arms. More... | |
| bool | UseZeroPose [set] |
| Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose. More... | |
| bool | SpinWhenInAir [set] |
| 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. More... | |
| float | M_armReachAmount [set] |
| How much the character reaches with his arms to brace against the ground. More... | |
| float | M_legPush [set] |
| Amount that the legs push outwards when tumbling. More... | |
| bool | TryToAvoidHeadButtingGround [set] |
| Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose. More... | |
| float | ArmReachLength [set] |
| The length that the arm reaches and so how much it straightens. More... | |
| Vector3 | CustomRollDir [set] |
| Pass in a custom direction in to have the character try and roll in that direction. More... | |
| bool | UseCustomRollDir [set] |
| Pass in true to use the customRollDir parameter. More... | |
| float | StiffnessDecayTarget [set] |
| The target linear velocity used to start the rolling. More... | |
| float | StiffnessDecayTime [set] |
| Time, in seconds, to decay stiffness down to the stiffnessDecayTarget value (or -1 to disable). 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 | ZAxisSpinReduction [set] |
| Tries to reduce the spin around the z axis. Scale 0 - 1. More... | |
| float | TargetLinearVelocityDecayTime [set] |
| Time for the targetlinearVelocity to decay to zero. More... | |
| float | TargetLinearVelocity [set] |
| Helper torques are applied to match the spin of the character to the max of targetLinearVelocity and COMVelMag. More... | |
| bool | OnlyApplyHelperForces [set] |
| Don't use rollup if true. More... | |
| bool | UseVelocityOfObjectBelow [set] |
| Scale applied cheat forces/torques to (zero) if object underneath character has velocity greater than 1.f. More... | |
| bool | UseRelativeVelocity [set] |
| UseVelocityOfObjectBelow uses a relative velocity of the character to the object underneath. More... | |
| bool | ApplyFoetalToLegs [set] |
| If true, use rollup for upper body and a kind of foetal behavior for legs. More... | |
| float | MovementLegsInFoetalPosition [set] |
| Only used if applyFoetalToLegs = true : define the variation of angles for the joints of the legs. More... | |
| float | MaxAngVelAroundFrontwardAxis [set] |
| Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : maximal angular velocity around frontward axis of the pelvis to apply cheating torques. More... | |
| float | MinAngVel [set] |
| Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : minimal angular velocity of the roll to apply cheating torques. More... | |
| bool | ApplyNewRollingCheatingTorques [set] |
| If true will use the new way to apply cheating torques (like in fallOverWall), otherwise will use the old way. More... | |
| float | MaxAngVel [set] |
| Only used if applyNewRollingCheatingTorques defined to true : maximal angular velocity of the roll to apply cheating torque. More... | |
| float | MagOfTorqueToRoll [set] |
| Only used if applyNewRollingCheatingTorques defined to true : magnitude of the torque to roll down the stairs. More... | |
| bool | ApplyHelPerTorqueToAlign [set] |
| Apply torque to align the body orthogonally to the direction of the roll. More... | |
| float | DelayToAlignBody [set] |
| Only used if applyHelPerTorqueToAlign defined to true : delay to start to apply torques. More... | |
| float | MagOfTorqueToAlign [set] |
| Only used if applyHelPerTorqueToAlign defined to true : magnitude of the torque to align orthogonally the body. More... | |
| float | AirborneReduction [set] |
| Ordinarily keep at 0.85. Make this lower if you want spinning in the air. More... | |
| bool | ApplyMinMaxFriction [set] |
| Pass-through to Roll Up. Controls whether or not behavior enforces min/max friction. More... | |
| bool | LimitSpinReduction [set] |
| Scale zAxisSpinReduction back when rotating end-over-end (somersault) to give the body a chance to align with the axis of rotation. 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
◆ RollDownStairsHelper()
| GTA.NaturalMotion.RollDownStairsHelper.RollDownStairsHelper | ( | Ped | ped | ) |
Creates a new Instance of the RollDownStairsHelper for sending a RollDownStairs Message to a given Ped.
Property Documentation
◆ AirborneReduction
|
set |
Ordinarily keep at 0.85. Make this lower if you want spinning in the air.
Default value = 0.9f. Min value = 0.0f. Max value = 1.0f.
◆ ApplyFoetalToLegs
|
set |
If true, use rollup for upper body and a kind of foetal behavior for legs.
Default value = False.
◆ ApplyHelPerTorqueToAlign
|
set |
Apply torque to align the body orthogonally to the direction of the roll.
Default value = False.
◆ ApplyMinMaxFriction
|
set |
Pass-through to Roll Up. Controls whether or not behavior enforces min/max friction.
Default value = True.
◆ ApplyNewRollingCheatingTorques
|
set |
If true will use the new way to apply cheating torques (like in fallOverWall), otherwise will use the old way.
Default value = False.
◆ ArmReachLength
|
set |
The length that the arm reaches and so how much it straightens.
Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.
◆ 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 = -1.0f. Max value = 1.0f.
◆ CustomRollDir
|
set |
Pass in a custom direction in to have the character try and roll in that direction.
Default value = Vector3(0.0f, 0.0f, 1.0f). Min value = 1.0f. Max value = 1.0f.
◆ Damping
|
set |
Effector Damping.
Default value = 1.4f. Min value = 0.0f. Max value = 4.0f.
◆ DelayToAlignBody
|
set |
Only used if applyHelPerTorqueToAlign defined to true : delay to start to apply torques.
Default value = 0.2f. Min value = 0.0f. Max value = 10.0f.
◆ Forcemag
|
set |
Helper force strength. Do not go above 1 for a rollDownStairs/roll along ground reaction.
Default value = 0.6f. Min value = 0.0f. Max value = 10.0f.
◆ LimitSpinReduction
|
set |
Scale zAxisSpinReduction back when rotating end-over-end (somersault) to give the body a chance to align with the axis of rotation.
Default value = False.
◆ M_armReachAmount
|
set |
How much the character reaches with his arms to brace against the ground.
Default value = 1.4f. Min value = 0.0f. Max value = 3.0f.
◆ M_legPush
|
set |
Amount that the legs push outwards when tumbling.
Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.
◆ M_useArmToSlowDown
|
set |
The degree to which the character will try to stop a barrel roll with his arms.
Default value = -1.9f. Min value = -3.0f. Max value = 3.0f.
◆ MagOfTorqueToAlign
|
set |
Only used if applyHelPerTorqueToAlign defined to true : magnitude of the torque to align orthogonally the body.
Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.
◆ MagOfTorqueToRoll
|
set |
Only used if applyNewRollingCheatingTorques defined to true : magnitude of the torque to roll down the stairs.
Default value = 50.0f. Min value = 0.0f. Max value = 500.0f.
◆ MaxAngVel
|
set |
Only used if applyNewRollingCheatingTorques defined to true : maximal angular velocity of the roll to apply cheating torque.
Default value = 5.0f. Min value = 0.0f. Max value = 10.0f.
◆ MaxAngVelAroundFrontwardAxis
|
set |
Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : maximal angular velocity around frontward axis of the pelvis to apply cheating torques.
Default value = 2.0f. Min value = -1.0f. Max value = 10.0f.
◆ MinAngVel
|
set |
Only used if applyNewRollingCheatingTorques or applyHelPerTorqueToAlign defined to true : minimal angular velocity of the roll to apply cheating torques.
Default value = 0.5f. Min value = 0.0f. Max value = 10.0f.
◆ MovementLegsInFoetalPosition
|
set |
Only used if applyFoetalToLegs = true : define the variation of angles for the joints of the legs.
Default value = 1.3f. Min value = 0.0f. Max value = 10.0f.
◆ OnlyApplyHelperForces
|
set |
Don't use rollup if true.
Default value = False.
◆ SpinWhenInAir
|
set |
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.
Default value = False.
◆ Stiffness
|
set |
Effector Stiffness. Value feeds through to rollUp directly.
Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.
◆ StiffnessDecayTarget
|
set |
The target linear velocity used to start the rolling.
Default value = 9.0f. Min value = 0.0f. Max value = 20.0f.
◆ StiffnessDecayTime
|
set |
Time, in seconds, to decay stiffness down to the stiffnessDecayTarget value (or -1 to disable).
Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.
◆ TargetLinearVelocity
|
set |
Helper torques are applied to match the spin of the character to the max of targetLinearVelocity and COMVelMag.
Default value = 1.0f. Min value = 0.0f. Max value = 10.0f.
◆ TargetLinearVelocityDecayTime
|
set |
Time for the targetlinearVelocity to decay to zero.
Default value = 0.5f. Min value = 0.0f. Max value = 2.0f.
◆ TryToAvoidHeadButtingGround
|
set |
Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.
Default value = False.
◆ UseCustomRollDir
|
set |
Pass in true to use the customRollDir parameter.
Default value = False.
◆ UseRelativeVelocity
|
set |
UseVelocityOfObjectBelow uses a relative velocity of the character to the object underneath.
Default value = False.
◆ UseVelocityOfObjectBelow
|
set |
Scale applied cheat forces/torques to (zero) if object underneath character has velocity greater than 1.f.
Default value = False.
◆ UseZeroPose
|
set |
Blends between a zeroPose and the Rollup, Faster the character is rotating the less the zeroPose.
Default value = False.
◆ ZAxisSpinReduction
|
set |
Tries to reduce the spin around the z axis. Scale 0 - 1.
Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.
The documentation for this class was generated from the following file:
- C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs
