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.SetCharacterUnderwaterHelper Class Reference

Sets viscosity applied to damping limbs. More...

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

Public Member Functions

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

bool Underwater [set]
 Is character underwater?. More...
 
float Viscosity [set]
 Viscosity applied to character's parts. More...
 
float GravityFactor [set]
 Gravity factor applied to character. More...
 
float Stroke [set]
 Swimming force applied to character as a function of handVelocity and footVelocity. More...
 
bool LinearStroke [set]
 Swimming force (linearStroke=true,False) = (f(v),f(v*v)). 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

Sets viscosity applied to damping limbs.

Constructor & Destructor Documentation

◆ SetCharacterUnderwaterHelper()

GTA.NaturalMotion.SetCharacterUnderwaterHelper.SetCharacterUnderwaterHelper ( Ped  ped)

Creates a new Instance of the SetCharacterUnderwaterHelper for sending a SetCharacterUnderwater Message to a given Ped.

Parameters
pedThe Ped to send the SetCharacterUnderwater Message to.

Sets viscosity applied to damping limbs.

Property Documentation

◆ GravityFactor

float GTA.NaturalMotion.SetCharacterUnderwaterHelper.GravityFactor
set

Gravity factor applied to character.

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

◆ LinearStroke

bool GTA.NaturalMotion.SetCharacterUnderwaterHelper.LinearStroke
set

Swimming force (linearStroke=true,False) = (f(v),f(v*v)).

Default value = False.

◆ Stroke

float GTA.NaturalMotion.SetCharacterUnderwaterHelper.Stroke
set

Swimming force applied to character as a function of handVelocity and footVelocity.

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

◆ Underwater

bool GTA.NaturalMotion.SetCharacterUnderwaterHelper.Underwater
set

Is character underwater?.

Default value = False.

◆ Viscosity

float GTA.NaturalMotion.SetCharacterUnderwaterHelper.Viscosity
set

Viscosity applied to character's parts.

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


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