Class ShotHelper

Inheritance

Object

CustomHelper

ShotHelper

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

Constructors

| Improve this Doc View Source

ShotHelper(Ped)

Creates a new Instance of the ShotHelper for sending a Shot Message to a given Ped.

Declaration

public ShotHelper(Ped ped)

Parameters

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

Properties

| Improve this Doc View Source

AllowInjuredArm

Injured arm code runs if arm hit (turns and steps and bends injured arm).

Declaration

public bool AllowInjuredArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

AllowInjuredLeg

When false injured leg is not bent and character does not bend to reach it.

Declaration

public bool AllowInjuredLeg { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

AllowInjuredLowerLegReach

When false don't try to reach for injured Lower Legs (shins/feet).

Declaration

public bool AllowInjuredLowerLegReach { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

AllowInjuredThighReach

When false don't try to reach for injured Thighs.

Declaration

public bool AllowInjuredThighReach { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

AlwaysResetLooseness

Looseness always reset on shotNewBullet even if previous looseness ramp still running. Except for the neck which has it's own ramp.

Declaration

public bool AlwaysResetLooseness { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

AlwaysResetNeckLooseness

Neck looseness always reset on shotNewBullet even if previous looseness ramp still running.

Declaration

public bool AlwaysResetNeckLooseness { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

AngVelScale

How much to scale the angular velocity coming in from animation of a part if it is in angVelScaleMask (otherwise scale by 1.0).

Declaration

public float AngVelScale { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

AngVelScaleMask

Parts to scale the initial angular velocity by angVelScale (otherwize scale by 1.0).

Declaration

public string AngVelScaleMask { set; }

Property Value

Type	Description
String

Remarks

Default value = "fb".

| Improve this Doc View Source

ArmStiffness

Arm stiffness.

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.

| Improve this Doc View Source

BodyStiffness

Stiffness of body. Feeds through to roll_up.

Declaration

public float BodyStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 11.0f. Min value = 6.0f. Max value = 16.0f.

| Improve this Doc View Source

BulletProofVest

Looseness applied to spine is different if bulletProofVest is true.

Declaration

public bool BulletProofVest { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

ChickenArms

Type of reaction.

Declaration

public bool ChickenArms { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

CpainDuration

Conscious pain duration at cpainMag/cpainTwistMag after cpainSmooth2Time.

Declaration

public float CpainDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CpainMag

Conscious pain spine Lean(back/Forward) magnitude (Replaces spinePainMultiplier).

Declaration

public float CpainMag { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CpainSmooth2Time

Conscious pain duration ramping from zero to cpainMag/cpainTwistMag.

Declaration

public float CpainSmooth2Time { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CpainSmooth2Zero

Conscious pain ramping to zero after cpainSmooth2Time + cpainDuration (Replaces spinePainTime).

Declaration

public float CpainSmooth2Zero { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CpainTwistMag

Conscious pain spine Twist/Lean2Side magnitude Replaces spinePainTwistMultiplier).

Declaration

public float CpainTwistMag { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

Crouching

Is the guy crouching or not.

Declaration

public bool Crouching { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

CStrLowerMax

Declaration

public float CStrLowerMax { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CStrLowerMin

Declaration

public float CStrLowerMin { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CStrUpperMax

Declaration

public float CStrUpperMax { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

CStrUpperMin

Proportions to what the strength would be normally.

Declaration

public float CStrUpperMin { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

DeathTime

Time to death (HACK for underwater). If -ve don't ever die.

Declaration

public float DeathTime { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ExagDuration

Exaggerate bullet duration (at exagMag/exagTwistMag).

Declaration

public float ExagDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ExagMag

Exaggerate bullet spine Lean magnitude.

Declaration

public float ExagMag { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ExagSmooth2Zero

Exaggerate bullet duration ramping to zero after exagDuration.

Declaration

public float ExagSmooth2Zero { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ExagTwistMag

Exaggerate bullet spine Twist magnitude.

Declaration

public float ExagTwistMag { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ExagZeroTime

Exaggerate bullet time spent at 0 spine lean/twist after exagDuration + exagSmooth2Zero.

Declaration

public float ExagZeroTime { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

FallingReaction

0=Rollup, 1=Catchfall, 2=rollDownStairs, 3=smartFall.

Declaration

public int FallingReaction { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = 0. Max value = 3.

| Improve this Doc View Source

Fling

Type of reaction.

Declaration

public bool Fling { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

FlingTime

Duration of the fling behavior.

Declaration

public float FlingTime { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

FlingWidth

Width of the fling behavior.

Declaration

public float FlingWidth { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

GrabHoldTime

How long to hold for before returning to relaxed arm position.

Declaration

public float GrabHoldTime { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InitialNeckDamping

Intial damping of neck after being shot.

Declaration

public float InitialNeckDamping { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InitialNeckDuration

Duration for which the neck stays at intial stiffness/damping.

Declaration

public float InitialNeckDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InitialNeckRampDuration

Duration of the ramp to bring the neck stiffness/damping back to normal levels.

Declaration

public float InitialNeckRampDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InitialNeckStiffness

Initial stiffness of neck after being shot.

Declaration

public float InitialNeckStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 14.0f. Min value = 3.0f. Max value = 16.0f.

| Improve this Doc View Source

InitialWeaknessRampDuration

Duration of the ramp to bring the character's upper body stiffness back to normal levels.

Declaration

public float InitialWeaknessRampDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InitialWeaknessZeroDuration

Duration for which the character's upper body stays at minimum stiffness (not quite zero).

Declaration

public float InitialWeaknessZeroDuration { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

KMult4Legs

How much to add to leg stiffnesses dependent on looseness.

Declaration

public float KMult4Legs { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

KMultOnLoose

How much to add to upperbody stiffness dependent on looseness.

Declaration

public float KMultOnLoose { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

Looseness4Fall

How loose the character is made by a newBullet if falling.

Declaration

public float Looseness4Fall { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

Looseness4Stagger

How loose the upperBody of the character is made by a newBullet if staggerFall is running (and not falling). Note atm the neck ramp values are ignored in staggerFall.

Declaration

public float Looseness4Stagger { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

LoosenessAmount

How loose the character is made by a newBullet. Between 0 and 1.

Declaration

public float LoosenessAmount { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

Melee

Declaration

public bool Melee { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

MinArmsLooseness

Minimum looseness to apply to the arms.

Declaration

public float MinArmsLooseness { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

MinLegsLooseness

Minimum looseness to apply to the Legs.

Declaration

public float MinLegsLooseness { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

NeckDamping

Damping of neck.

Declaration

public float NeckDamping { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.1f. Max value = 2.0f.

| Improve this Doc View Source

NeckStiffness

Stiffness of neck.

Declaration

public float NeckStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = 14.0f. Min value = 3.0f. Max value = 16.0f.

| Improve this Doc View Source

ReachForWound

Type of reaction.

Declaration

public bool ReachForWound { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

SpineBlendExagCPain

True: spine is blended with zero pose, false: spine is blended with zero pose if not setting exag or cpain.

Declaration

public bool SpineBlendExagCPain { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

SpineBlendZero

Spine is always blended with zero pose this much and up to 1 as the character become stationary. If negative no blend is ever applied.

Declaration

public float SpineBlendZero { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.6f. Min value = -0.1f. Max value = 1.0f.

| Improve this Doc View Source

SpineDamping

Stiffness of body. Feeds through to roll_up.

Declaration

public float SpineDamping { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.1f. Max value = 2.0f.

| Improve this Doc View Source

StableHandsAndNeck

Additional stability for hands and neck (less loose).

Declaration

public bool StableHandsAndNeck { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

TimeBeforeReachForWound

Time, in seconds, before the character begins to grab for the wound on the first hit.

Declaration

public float TimeBeforeReachForWound { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

UseCStrModulation

If enabled upper and lower body strength scales with character strength, using the range given by parameters below.

Declaration

public bool UseCStrModulation { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

UseExtendedCatchFall

Keep the character active instead of relaxing at the end of the catch fall.

Declaration

public bool UseExtendedCatchFall { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.