Class BuoyancyHelper

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

Inheritance

Object

CustomHelper

BuoyancyHelper

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

Constructors

BuoyancyHelper(Ped)

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

Declaration

public BuoyancyHelper(Ped ped)

Parameters

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

Remarks

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

Properties

Buoyancy

Buoyancy multiplier.

Declaration

public float Buoyancy { set; }

Property Value

Type	Description
Single

Remarks

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

ChestBuoyancy

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

Declaration

public float ChestBuoyancy { set; }

Property Value

Type	Description
Single

Remarks

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

Damping

Damping for submerged parts.

Declaration

public float Damping { set; }

Property Value

Type	Description
Single

Remarks

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

Righting

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

Declaration

public bool Righting { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

RightingStrength

Strength of righting torque.

Declaration

public float RightingStrength { set; }

Property Value

Type	Description
Single

Remarks

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

RightingTime

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

Declaration

public float RightingTime { set; }

Property Value

Type	Description
Single

Remarks

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

SurfaceNormal

Normal to surface of water.

Declaration

public Vector3 SurfaceNormal { set; }

Property Value

Type	Description
Vector3

Remarks

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

SurfacePoint

Arbitrary point on surface of water.

Declaration

public Vector3 SurfacePoint { set; }

Property Value

Type	Description
Vector3

Remarks

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