Public Member Functions | |
| BodyWritheHelper (Ped ped) | |
| Creates a new Instance of the BodyWritheHelper for sending a BodyWrithe 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 | ArmStiffness [set] |
| float | BackStiffness [set] |
| float | LegStiffness [set] |
| The stiffness of the character will determine how 'determined' a writhe this is - high values will make him thrash about wildly. More... | |
| float | ArmDamping [set] |
| Damping amount, less is underdamped. More... | |
| float | BackDamping [set] |
| Damping amount, less is underdamped. More... | |
| float | LegDamping [set] |
| Damping amount, less is underdamped. More... | |
| float | ArmPeriod [set] |
| Controls how fast the writhe is executed, smaller values make faster motions. More... | |
| float | BackPeriod [set] |
| Controls how fast the writhe is executed, smaller values make faster motions. More... | |
| float | LegPeriod [set] |
| Controls how fast the writhe is executed, smaller values make faster motions. 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 | ArmAmplitude [set] |
| float | BackAmplitude [set] |
| Scales the amount of writhe. 0 = no writhe. More... | |
| float | LegAmplitude [set] |
| Scales the amount of writhe. 0 = no writhe. More... | |
| float | ElbowAmplitude [set] |
| float | KneeAmplitude [set] |
| bool | RollOverFlag [set] |
| Flag to set trying to rollOver. More... | |
| float | BlendArms [set] |
| Blend the writhe arms with the current desired arms (0=don't apply any writhe, 1=only writhe). More... | |
| float | BlendBack [set] |
| Blend the writhe spine and neck with the current desired (0=don't apply any writhe, 1=only writhe). More... | |
| float | BlendLegs [set] |
| Blend the writhe legs with the current desired legs (0=don't apply any writhe, 1=only writhe). More... | |
| bool | ApplyStiffness [set] |
| Use writhe stiffnesses if true. If false don't set any stiffnesses. More... | |
| bool | OnFire [set] |
| Extra shoulderBlend. Rolling:one way only, maxRollOverTime, rollOverRadius, doesn't reduce arm stiffness to help rolling. No shoulder twist. More... | |
| float | ShoulderLean1 [set] |
| Blend writhe shoulder desired lean1 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect. More... | |
| float | ShoulderLean2 [set] |
| Blend writhe shoulder desired lean2 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect. More... | |
| float | Lean1BlendFactor [set] |
| Shoulder desired lean1 with shoulderLean1 angle blend factor. Set it to 0 to use original shoulder withe desired lean1 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect. More... | |
| float | Lean2BlendFactor [set] |
| Shoulder desired lean2 with shoulderLean2 angle blend factor. Set it to 0 to use original shoulder withe desired lean2 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect. More... | |
| float | RollTorqueScale [set] |
| Scale rolling torque that is applied to character spine. 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. Note that onFire has to be set to true for this parameter to take any effect. 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. Note that onFire has to be set to true for this parameter to take any effect. 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
◆ BodyWritheHelper()
| GTA.NaturalMotion.BodyWritheHelper.BodyWritheHelper | ( | Ped | ped | ) |
Creates a new Instance of the BodyWritheHelper for sending a BodyWrithe Message to a given Ped.
Property Documentation
◆ ApplyStiffness
|
set |
Use writhe stiffnesses if true. If false don't set any stiffnesses.
Default value = True.
◆ ArmAmplitude
|
set |
Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.
◆ ArmDamping
|
set |
Damping amount, less is underdamped.
Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.
◆ ArmPeriod
|
set |
Controls how fast the writhe is executed, smaller values make faster motions.
Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.
◆ ArmStiffness
|
set |
Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.
◆ BackAmplitude
|
set |
Scales the amount of writhe. 0 = no writhe.
Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.
◆ BackDamping
|
set |
Damping amount, less is underdamped.
Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.
◆ BackPeriod
|
set |
Controls how fast the writhe is executed, smaller values make faster motions.
Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.
◆ BackStiffness
|
set |
Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.
◆ BlendArms
|
set |
Blend the writhe arms with the current desired arms (0=don't apply any writhe, 1=only writhe).
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ BlendBack
|
set |
Blend the writhe spine and neck with the current desired (0=don't apply any writhe, 1=only writhe).
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ BlendLegs
|
set |
Blend the writhe legs with the current desired legs (0=don't apply any writhe, 1=only writhe).
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ ElbowAmplitude
|
set |
Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.
◆ KneeAmplitude
|
set |
Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.
◆ Lean1BlendFactor
|
set |
Shoulder desired lean1 with shoulderLean1 angle blend factor. Set it to 0 to use original shoulder withe desired lean1 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.
◆ Lean2BlendFactor
|
set |
Shoulder desired lean2 with shoulderLean2 angle blend factor. Set it to 0 to use original shoulder withe desired lean2 angle for shoulders. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.
◆ LegAmplitude
|
set |
Scales the amount of writhe. 0 = no writhe.
Default value = 1.0f. Min value = 0.0f. Max value = 3.0f.
◆ LegDamping
|
set |
Damping amount, less is underdamped.
Default value = 0.5f. Min value = 0.0f. Max value = 3.0f.
◆ LegPeriod
|
set |
Controls how fast the writhe is executed, smaller values make faster motions.
Default value = 1.0f. Min value = 0.0f. Max value = 4.0f.
◆ LegStiffness
|
set |
The stiffness of the character will determine how 'determined' a writhe this is - high values will make him thrash about wildly.
Default value = 13.0f. Min value = 6.0f. Max value = 16.0f.
◆ 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".
◆ 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. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 8.0f. Min value = 0.0f. Max value = 60.0f.
◆ OnFire
|
set |
Extra shoulderBlend. Rolling:one way only, maxRollOverTime, rollOverRadius, doesn't reduce arm stiffness to help rolling. No shoulder twist.
Default value = False.
◆ RollOverFlag
|
set |
Flag to set trying to rollOver.
Default value = False.
◆ 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. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 2.0f. Min value = 0.0f. Max value = 10.0f.
◆ RollTorqueScale
|
set |
Scale rolling torque that is applied to character spine.
Default value = 150.0f. Min value = 0.0f. Max value = 300.0f.
◆ ShoulderLean1
|
set |
Blend writhe shoulder desired lean1 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 0.7f. Min value = 0.0f. Max value = 6.3f.
◆ ShoulderLean2
|
set |
Blend writhe shoulder desired lean2 with this angle in RAD. Note that onFire has to be set to true for this parameter to take any effect.
Default value = 0.4f. Min value = 0.0f. Max value = 6.3f.
The documentation for this class was generated from the following file:
- C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs
