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

Simple buoyancy model. No character movement just fluid forces/torques added to parts. More...

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

Public Member Functions

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

Vector3 SurfacePoint [set]
 Arbitrary point on surface of water. More...
 
Vector3 SurfaceNormal [set]
 Normal to surface of water. More...
 
float Buoyancy [set]
 Buoyancy multiplier. More...
 
float ChestBuoyancy [set]
 Buoyancy multiplier for spine2/3. Helps character float upright. More...
 
float Damping [set]
 Damping for submerged parts. More...
 
bool Righting [set]
 Use righting torque to being character face-up in water?. More...
 
float RightingStrength [set]
 Strength of righting torque. More...
 
float RightingTime [set]
 How long to wait after chest hits water to begin righting torque. 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

Simple buoyancy model. No character movement just fluid forces/torques added to parts.

Constructor & Destructor Documentation

◆ BuoyancyHelper()

GTA.NaturalMotion.BuoyancyHelper.BuoyancyHelper ( Ped  ped)

Creates a new Instance of the BuoyancyHelper for sending a Buoyancy Message to a given Ped.

Parameters
pedThe Ped to send the Buoyancy Message to.

Simple buoyancy model. No character movement just fluid forces/torques added to parts.

Property Documentation

◆ Buoyancy

float GTA.NaturalMotion.BuoyancyHelper.Buoyancy
set

Buoyancy multiplier.

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

◆ ChestBuoyancy

float GTA.NaturalMotion.BuoyancyHelper.ChestBuoyancy
set

Buoyancy multiplier for spine2/3. Helps character float upright.

Default value = 8.0f. Min value = 0.0f.

◆ Damping

float GTA.NaturalMotion.BuoyancyHelper.Damping
set

Damping for submerged parts.

Default value = 40.0f. Min value = 0.0f.

◆ Righting

bool GTA.NaturalMotion.BuoyancyHelper.Righting
set

Use righting torque to being character face-up in water?.

Default value = True.

◆ RightingStrength

float GTA.NaturalMotion.BuoyancyHelper.RightingStrength
set

Strength of righting torque.

Default value = 25.0f. Min value = 0.0f.

◆ RightingTime

float GTA.NaturalMotion.BuoyancyHelper.RightingTime
set

How long to wait after chest hits water to begin righting torque.

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

◆ SurfaceNormal

Vector3 GTA.NaturalMotion.BuoyancyHelper.SurfaceNormal
set

Normal to surface of water.

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

◆ SurfacePoint

Vector3 GTA.NaturalMotion.BuoyancyHelper.SurfacePoint
set

Arbitrary point on surface of water.

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


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