Class ElectrocuteHelper

Inheritance

Object

CustomHelper

ElectrocuteHelper

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

Constructors

ElectrocuteHelper(Ped)

Creates a new Instance of the ElectrocuteHelper for sending a Electrocute Message to a given Ped.

Declaration

public ElectrocuteHelper(Ped ped)

Parameters

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

Properties

AirborneMult

AirborneMult*stunMag = The magnitude of the reaction if airborne.

Declaration

public float AirborneMult { set; }

Property Value

Type	Description
Single

Remarks

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

ApplyStiffness

Let electrocute apply a (higher generally) stiffness to the character whilst being vibrated.

Declaration

public bool ApplyStiffness { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

BalancingMult

BalancingMult*stunMag = The magnitude of the reaction if balancing = (not lying on the floor/ not upper body not collided) and not airborne.

Declaration

public float BalancingMult { set; }

Property Value

Type	Description
Single

Remarks

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

DirectionRandomness

The character vibrates in a prescribed way - Higher the value the more random this direction is.

Declaration

public float DirectionRandomness { set; }

Property Value

Type	Description
Single

Remarks

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

HipType

Type of hip reaction 0=none, 1=side2side 2=steplike.

Declaration

public int HipType { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 2. Min value = 0. Max value = 2.

InitialMult

InitialMult*stunMag = The magnitude of the 1st snap reaction (other multipliers are applied after this).

Declaration

public float InitialMult { set; }

Property Value

Type	Description
Single

Remarks

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

LargeMaxTime

Max time to next large random snap (about 28 snaps with stunInterval = 0.07s).

Declaration

public float LargeMaxTime { set; }

Property Value

Type	Description
Single

Remarks

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

LargeMinTime

Min time to next large random snap (about 14 snaps with stunInterval = 0.07s).

Declaration

public float LargeMinTime { set; }

Property Value

Type	Description
Single

Remarks

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

LargeMult

LargeMult*stunMag = The magnitude of a random large snap reaction (other multipliers are applied after this).

Declaration

public float LargeMult { set; }

Property Value

Type	Description
Single

Remarks

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

LeftArm

Vibrate the leftArm.

Declaration

public bool LeftArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

LeftLeg

Vibrate the leftLeg.

Declaration

public bool LeftLeg { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

MovingMult

MovingMult*stunMag = The magnitude of the reaction if moving(comVelMag) faster than movingThresh.

Declaration

public float MovingMult { set; }

Property Value

Type	Description
Single

Remarks

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

MovingThresh

If moving(comVelMag) faster than movingThresh then mvingMult applied to stunMag.

Declaration

public float MovingThresh { set; }

Property Value

Type	Description
Single

Remarks

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

Neck

Vibrate the neck.

Declaration

public bool Neck { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

PhasedLegs

Legs are either in phase with each other or not.

Declaration

public bool PhasedLegs { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

RightArm

Vibrate the rightArm.

Declaration

public bool RightArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

RightLeg

Vibrate the rightLeg.

Declaration

public bool RightLeg { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

Spine

Vibrate the spine.

Declaration

public bool Spine { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

StunInterval

Direction flips every stunInterval.

Declaration

public float StunInterval { set; }

Property Value

Type	Description
Single

Remarks

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

StunMag

The magnitude of the reaction.

Declaration

public float StunMag { set; }

Property Value

Type	Description
Single

Remarks

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

UseTorques

Use torques to make vibration otherwise use a change in the parts angular velocity.

Declaration

public bool UseTorques { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.