CryEngine.AreaParameters

CryEngine.AreaParameters

Inherits CryEngine.BasePhysicsParameters< pe_params_area >.

Classes

class WaveSimulationParameters

Properties

WaveSimulationParameters WaveSimulation [get]
Wave simulation parameters More...
Vector3 Gravity [get, set]
Gravity in this area. Depending on the value of Uniform the gravity will have the same direction in every point, or always points to the center. More...
float Falloff [get, set]
Parametric distance (0..1) where falloff starts More...
bool Uniform [get, set]
Gravity has same direction in every point or always points to the center More...
bool UseCallback [get, set]
Will generate immediate EventPhysArea when needs to apply params to an entity More...
float Damping [get, set]
Uniform damping More...
IGeometry Geometry [get, set]
Physical geometry used in the area More...
float Volume [get, set]
The area will try to maintain this volume by adjusting water level More...
float VolumeAccuracy [get, set]
Accuracy of level computation based on volume (in fractions of the volume) More...
float BorderPadding [get, set]
After adjusting level, expand the border by this distance More...
bool ConvexBorder [get, set]
Forces convex border after water level adjustments More...
float ObjectVolumeThreshold [get, set]
Only consider entities larger than this for level adjustment (set in fractions of area volume) More...
float CellSize [get, set]
Cell size for wave simulation More...
float GrowthReserve [get, set]
Assume this area increase during level adjustment (only used for wave simulation) More...

Property Documentation

◆ BorderPadding

float CryEngine.AreaParameters.BorderPadding
get
set

After adjusting level, expand the border by this distance

◆ CellSize

float CryEngine.AreaParameters.CellSize
get
set

Cell size for wave simulation

◆ ConvexBorder

bool CryEngine.AreaParameters.ConvexBorder
get
set

Forces convex border after water level adjustments

◆ Damping

float CryEngine.AreaParameters.Damping
get
set

Uniform damping

◆ Falloff

float CryEngine.AreaParameters.Falloff
get
set

Parametric distance (0..1) where falloff starts

◆ Geometry

IGeometry CryEngine.AreaParameters.Geometry
get
set

Physical geometry used in the area

◆ Gravity

Vector3 CryEngine.AreaParameters.Gravity
get
set

Gravity in this area. Depending on the value of Uniform the gravity will have the same direction in every point, or always points to the center.

◆ GrowthReserve

float CryEngine.AreaParameters.GrowthReserve
get
set

Assume this area increase during level adjustment (only used for wave simulation)

◆ ObjectVolumeThreshold

float CryEngine.AreaParameters.ObjectVolumeThreshold
get
set

Only consider entities larger than this for level adjustment (set in fractions of area volume)

◆ Uniform

bool CryEngine.AreaParameters.Uniform
get
set

Gravity has same direction in every point or always points to the center

◆ UseCallback

bool CryEngine.AreaParameters.UseCallback
get
set

Will generate immediate EventPhysArea when needs to apply params to an entity

◆ Volume

float CryEngine.AreaParameters.Volume
get
set

The area will try to maintain this volume by adjusting water level

◆ VolumeAccuracy

float CryEngine.AreaParameters.VolumeAccuracy
get
set

Accuracy of level computation based on volume (in fractions of the volume)

◆ WaveSimulation

WaveSimulationParameters CryEngine.AreaParameters.WaveSimulation
get

Wave simulation parameters