CryEngine.BuoyancyParameters

Public Types | Properties | List of all members

Inherits CryEngine.BasePhysicsParameters< pe_params_buoyancy >.

Public Types
enum	MediumType { MediumType.Water = 0, MediumType.Air = 1 }

Properties
float	WaterDensity `[get, set]`
	Overrides water density from the current water volume for an entity; sets for water areas. More...

float	KWaterDensity `[get, set]`
	Scales water density from the current water volume (used for entities only). NOTE: for entities , WaterDensity override is stored as KWaterDensity relative to the global area's density. More...

float	WaterDamping `[get, set]`
	Uniform damping while submerged, will be scaled with submerged fraction. More...

float	WaterResistance `[get, set]`
	The resistance of this water medium. More...

float	KWaterResistance `[get, set]`
	Scales water resistance from the current water volume (used for entities only). NOTE: For entities , WaterResistance override is stored as KWaterResistance relative to the global area's density. More...

Vector3	WaterFlow `[get, set]`
	The movement vector for the flow. Can only be set for a water area. More...

float	FlowVariance `[get, set]`
	Not yet supported. More...

Common.primitives.plane	WaterPlane `[get, set]`
	Positive normal = above the water surface. More...

float	WaterMinEnergy `[get, set]`
	Sleep energy while floating with no contacts. More...

MediumType	Medium `[get, set]`
	Specify whether this is water or air. More...

Member Enumeration Documentation

◆ MediumType

enum CryEngine.BuoyancyParameters.MediumType

strong

Enumerator
Water
Air

Property Documentation

◆ FlowVariance

float CryEngine.BuoyancyParameters.FlowVariance

get

set

Not yet supported.

◆ KWaterDensity

float CryEngine.BuoyancyParameters.KWaterDensity

get

set

Scales water density from the current water volume (used for entities only). NOTE: for entities , WaterDensity override is stored as KWaterDensity relative to the global area's density.

◆ KWaterResistance

float CryEngine.BuoyancyParameters.KWaterResistance

get

set

Scales water resistance from the current water volume (used for entities only). NOTE: For entities , WaterResistance override is stored as KWaterResistance relative to the global area's density.

◆ Medium

MediumType CryEngine.BuoyancyParameters.Medium

get

set

Specify whether this is water or air.

◆ WaterDamping

float CryEngine.BuoyancyParameters.WaterDamping

get

set

Uniform damping while submerged, will be scaled with submerged fraction.

◆ WaterDensity

float CryEngine.BuoyancyParameters.WaterDensity

get

set

Overrides water density from the current water volume for an entity; sets for water areas.

◆ WaterFlow

Vector3 CryEngine.BuoyancyParameters.WaterFlow

get

set

The movement vector for the flow. Can only be set for a water area.

◆ WaterMinEnergy

float CryEngine.BuoyancyParameters.WaterMinEnergy

get

set

Sleep energy while floating with no contacts.

◆ WaterPlane

Common.primitives.plane CryEngine.BuoyancyParameters.WaterPlane

get

set

Positive normal = above the water surface.

◆ WaterResistance

float CryEngine.BuoyancyParameters.WaterResistance

get

set

The resistance of this water medium.