Configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces. More...
Public Member Functions | |
| ShotShockSpinHelper (Ped ped) | |
| Creates a new Instance of the ShotShockSpinHelper for sending a ShotShockSpin 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 | |
| bool | AddShockSpin [set] |
| If enabled, add a short 'shock' of torque to the character's spine to exaggerate bullet impact. More... | |
| bool | RandomizeShockSpinDirection [set] |
| For use with close-range shotgun blasts, or similar. More... | |
| bool | AlwaysAddShockSpin [set] |
| If true, apply the shock spin no matter which body component was hit. Otherwise only apply if the spine or clavicles get hit. More... | |
| float | ShockSpinMin [set] |
| Minimum amount of torque to add if using shock-spin feature. More... | |
| float | ShockSpinMax [set] |
| Maximum amount of torque to add if using shock-spin feature. More... | |
| float | ShockSpinLiftForceMult [set] |
| If greater than 0, apply a force to lift the character up while the torque is applied, trying to produce a dramatic spun/twist shotgun-to-the-chest effect. This is a scale of the torque applied, so 8.0 or so would give a reasonable amount of lift. More... | |
| float | ShockSpinDecayMult [set] |
| Multiplier used when decaying torque spin over time. More... | |
| float | ShockSpinScalePerComponent [set] |
| Torque applied is scaled by this amount across the spine components - spine2 recieving the full amount, then 3 and 1 and finally 0. Each time, this value is used to scale it down. 0.5 means half the torque each time. More... | |
| float | ShockSpinMaxTwistVel [set] |
| Shock spin ends when twist velocity is greater than this value (try 6.0). If set to -1 does not stop. More... | |
| bool | ShockSpinScaleByLeverArm [set] |
| Shock spin scales by lever arm of bullet i.e. bullet impact point to center line. More... | |
| float | ShockSpinAirMult [set] |
| ShockSpin's torque is multipied by this value when both the character's feet are not in contact. More... | |
| float | ShockSpin1FootMult [set] |
| ShockSpin's torque is multipied by this value when the one of the character's feet are not in contact. More... | |
| float | ShockSpinFootGripMult [set] |
| ShockSpin scales the torques applied to the feet by footSlipCompensation. More... | |
| float | BracedSideSpinMult [set] |
| If shot on a side with a forward foot and both feet are on the ground and balanced, increase the shockspin to compensate for the balancer naturally resisting spin to that side. 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... | |
Detailed Description
Configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.
Constructor & Destructor Documentation
◆ ShotShockSpinHelper()
| GTA.NaturalMotion.ShotShockSpinHelper.ShotShockSpinHelper | ( | Ped | ped | ) |
Creates a new Instance of the ShotShockSpinHelper for sending a ShotShockSpin Message to a given Ped.
Configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.
Property Documentation
◆ AddShockSpin
|
set |
If enabled, add a short 'shock' of torque to the character's spine to exaggerate bullet impact.
Default value = False.
◆ AlwaysAddShockSpin
|
set |
If true, apply the shock spin no matter which body component was hit. Otherwise only apply if the spine or clavicles get hit.
Default value = False.
◆ BracedSideSpinMult
|
set |
If shot on a side with a forward foot and both feet are on the ground and balanced, increase the shockspin to compensate for the balancer naturally resisting spin to that side.
Default value = 1.0f. Min value = 1.0f. Max value = 5.0f.
◆ RandomizeShockSpinDirection
|
set |
For use with close-range shotgun blasts, or similar.
Default value = False.
◆ ShockSpin1FootMult
|
set |
ShockSpin's torque is multipied by this value when the one of the character's feet are not in contact.
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ ShockSpinAirMult
|
set |
ShockSpin's torque is multipied by this value when both the character's feet are not in contact.
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ ShockSpinDecayMult
|
set |
Multiplier used when decaying torque spin over time.
Default value = 4.0f. Min value = 0.0f. Max value = 10.0f.
◆ ShockSpinFootGripMult
|
set |
ShockSpin scales the torques applied to the feet by footSlipCompensation.
Default value = 1.0f. Min value = 0.0f. Max value = 1.0f.
◆ ShockSpinLiftForceMult
|
set |
If greater than 0, apply a force to lift the character up while the torque is applied, trying to produce a dramatic spun/twist shotgun-to-the-chest effect. This is a scale of the torque applied, so 8.0 or so would give a reasonable amount of lift.
Default value = 0.0f. Min value = 0.0f. Max value = 2.0f.
◆ ShockSpinMax
|
set |
Maximum amount of torque to add if using shock-spin feature.
Default value = 90.0f. Min value = 0.0f. Max value = 1000.0f.
◆ ShockSpinMaxTwistVel
|
set |
Shock spin ends when twist velocity is greater than this value (try 6.0). If set to -1 does not stop.
Default value = -1.0f. Min value = -1.0f. Max value = 200.0f.
◆ ShockSpinMin
|
set |
Minimum amount of torque to add if using shock-spin feature.
Default value = 50.0f. Min value = 0.0f. Max value = 1000.0f.
◆ ShockSpinScaleByLeverArm
|
set |
Shock spin scales by lever arm of bullet i.e. bullet impact point to center line.
Default value = True.
◆ ShockSpinScalePerComponent
|
set |
Torque applied is scaled by this amount across the spine components - spine2 recieving the full amount, then 3 and 1 and finally 0. Each time, this value is used to scale it down. 0.5 means half the torque each time.
Default value = 0.5f. Min value = 0.0f. Max value = 2.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
