Class ShotShockSpinHelper

Configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.

Inheritance

Object

CustomHelper

ShotShockSpinHelper

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

Constructors

ShotShockSpinHelper(Ped)

Creates a new Instance of the ShotShockSpinHelper for sending a ShotShockSpin Message to a given Ped.

Declaration

public ShotShockSpinHelper(Ped ped)

Parameters

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

Remarks

Configure the shockSpin effect in shot. Spin/Lift the character using cheat torques/forces.

Properties

AddShockSpin

If enabled, add a short 'shock' of torque to the character's spine to exaggerate bullet impact.

Declaration

public bool AddShockSpin { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

AlwaysAddShockSpin

If true, apply the shock spin no matter which body component was hit. Otherwise only apply if the spine or clavicles get hit.

Declaration

public bool AlwaysAddShockSpin { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

BracedSideSpinMult

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.

Declaration

public float BracedSideSpinMult { set; }

Property Value

Type	Description
Single

Remarks

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

RandomizeShockSpinDirection

For use with close-range shotgun blasts, or similar.

Declaration

public bool RandomizeShockSpinDirection { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

ShockSpin1FootMult

ShockSpin's torque is multipied by this value when the one of the character's feet are not in contact.

Declaration

public float ShockSpin1FootMult { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinAirMult

ShockSpin's torque is multipied by this value when both the character's feet are not in contact.

Declaration

public float ShockSpinAirMult { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinDecayMult

Multiplier used when decaying torque spin over time.

Declaration

public float ShockSpinDecayMult { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinFootGripMult

ShockSpin scales the torques applied to the feet by footSlipCompensation.

Declaration

public float ShockSpinFootGripMult { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinLiftForceMult

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.

Declaration

public float ShockSpinLiftForceMult { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinMax

Maximum amount of torque to add if using shock-spin feature.

Declaration

public float ShockSpinMax { set; }

Property Value

Type	Description
Single

Remarks

Default value = 90.0f. Min value = 0.0f. Max value = 1000.0f.

ShockSpinMaxTwistVel

Shock spin ends when twist velocity is greater than this value (try 6.0). If set to -1 does not stop.

Declaration

public float ShockSpinMaxTwistVel { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinMin

Minimum amount of torque to add if using shock-spin feature.

Declaration

public float ShockSpinMin { set; }

Property Value

Type	Description
Single

Remarks

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

ShockSpinScaleByLeverArm

Shock spin scales by lever arm of bullet i.e. bullet impact point to center line.

Declaration

public bool ShockSpinScaleByLeverArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

ShockSpinScalePerComponent

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.

Declaration

public float ShockSpinScalePerComponent { set; }

Property Value

Type	Description
Single

Remarks

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