SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.NaturalMotion.FireWeaponHelper Class Reference

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

Inheritance diagram for GTA.NaturalMotion.FireWeaponHelper:
GTA.NaturalMotion.CustomHelper

Public Member Functions

 FireWeaponHelper (Ped ped)
 Creates a new Instance of the FireWeaponHelper for sending a FireWeapon 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

float FiredWeaponStrength [set]
 The force of the gun. More...
 
Hand GunHandEnum [set]
 Which hand is the gun in. More...
 
bool ApplyFireGunForceAtClavicle [set]
 Should we apply some of the force at the shoulder. Force double handed weapons (Ak47 etc). More...
 
float InhibitTime [set]
 Minimum time before next fire impulse. More...
 
Vector3 Direction [set]
 Direction of impulse in gun frame. More...
 
float Split [set]
 Split force between hand and clavicle when applyFireGunForceAtClavicle is true. 1 = all hand, 0 = all clavicle. 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

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

Constructor & Destructor Documentation

◆ FireWeaponHelper()

GTA.NaturalMotion.FireWeaponHelper.FireWeaponHelper ( Ped  ped)

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

Parameters
pedThe Ped to send the FireWeapon Message to.

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

Property Documentation

◆ ApplyFireGunForceAtClavicle

bool GTA.NaturalMotion.FireWeaponHelper.ApplyFireGunForceAtClavicle
set

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

Default value = False.

◆ Direction

Vector3 GTA.NaturalMotion.FireWeaponHelper.Direction
set

Direction of impulse in gun frame.

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

◆ FiredWeaponStrength

float GTA.NaturalMotion.FireWeaponHelper.FiredWeaponStrength
set

The force of the gun.

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

◆ GunHandEnum

Hand GTA.NaturalMotion.FireWeaponHelper.GunHandEnum
set

Which hand is the gun in.

Default value = Hand.Left.

◆ InhibitTime

float GTA.NaturalMotion.FireWeaponHelper.InhibitTime
set

Minimum time before next fire impulse.

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

◆ Split

float GTA.NaturalMotion.FireWeaponHelper.Split
set

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

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


The documentation for this class was generated from the following file: