Class FireWeaponHelper

One shot message apply a force to the hand as we fire the gun that should be in this hand.

Inheritance

Object

CustomHelper

FireWeaponHelper

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

Constructors

FireWeaponHelper(Ped)

Creates a new Instance of the FireWeaponHelper for sending a FireWeapon Message to a given Ped.

Declaration

public FireWeaponHelper(Ped ped)

Parameters

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

Remarks

One shot message apply a force to the hand as we fire the gun that should be in this hand.

Properties

ApplyFireGunForceAtClavicle

Should we apply some of the force at the shoulder. Force double handed weapons (Ak47 etc).

Declaration

public bool ApplyFireGunForceAtClavicle { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

Direction

Direction of impulse in gun frame.

Declaration

public Vector3 Direction { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f).

FiredWeaponStrength

The force of the gun.

Declaration

public float FiredWeaponStrength { set; }

Property Value

Type	Description
Single

Remarks

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

GunHandEnum

Which hand is the gun in.

Declaration

public Hand GunHandEnum { set; }

Property Value

Type	Description
Hand

Remarks

Default value = Left.

InhibitTime

Minimum time before next fire impulse.

Declaration

public float InhibitTime { set; }

Property Value

Type	Description
Single

Remarks

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

Split

Split force between hand and clavicle when applyFireGunForceAtClavicle is true. 1 = all hand, 0 = all clavicle.

Declaration

public float Split { set; }

Property Value

Type	Description
Single

Remarks

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