TiMan: Add source-verified reference and identify information needing expansion.

2026-10-02T11:34:48Z

Add source-verified reference and identify information needing expansion.

New page

{{shortPageTitle}}
{{stub}}

<code>Liquid</code> is an area class defined in <code>editor/userclasses/AreaClasses.def</code> in SOMA, Amnesia: Rebirth and Amnesia: The Bunker.

== Class variables ==
The following table records the shared class variables and their definition defaults. Descriptions are taken from the class definitions.

{| class="wikitable"
! Variable !! Type !! Definition default !! Description
|-
| <code>Density</code> || <code>Float</code> || <code>100</code> || Density of the water. The higher the heavier things float.
|-
| <code>LinearViscosity</code> || <code>Float</code> || <code>1</code> || The higher, the more slowed down things will be in linear transformations (changing position)
|-
| <code>AngularViscosity</code> || <code>Float</code> || <code>1</code> || The higher, the more slowed down things will be in angular transformations (changing rotation)
|-
| <code>PhysicsMaterial</code> || <code>Enum</code> || <code>0</code> || Material of water.
|-
| <code>PlayerSpeedMul</code> || <code>Float</code> || <code>0.8</code> || Player speed is multiplied by this when in water.
|-
| <code>HasWaves</code> || <code>Bool</code> || <code>true</code> || If object will go up and down in a wavelike manner.
|-
| <code>WaveAmp</code> || <code>Float</code> || <code>0.04</code> || Height of waves.
|-
| <code>WaveFreq</code> || <code>Float</code> || <code>3</code> || How fast the waves will go up and down.
|-
| <code>MaxWaveDistance</code> || <code>Float</code> || <code>25</code> || Max distance from player that objects get waves. This is an optimization thingie.
|-
| <code>UpperMaterial</code> || <code>File</code> || <code>""</code> || The material of upper water surface.
|-
| <code>LowerMaterial</code> || <code>File</code> || <code>""</code> || The material of lower water surface.
|-
| <code>GridSize</code> || <code>Float</code> || <code>0</code> || Size of the grid tiles. 0 = no grid
|-
| <code>TextureTileSize</code> || <code>Float</code> || <code>1</code> || Size that a full texture takes up.
|-
| <code>StaticMesh</code> || <code>Bool</code> || <code>true</code> || If the area is never to move, it is best to have it as static! (renders faster)
|-
| <code>EnvParticlesToClip</code> || <code>String</code> || <code>""</code> || Name of the environment particle layers that should be constrained to this area. Wildcard accepted, use space to seperate multiple
|-
| <code>UseFog</code> || <code>Bool</code> || <code>true</code> || If there should be fog under the water.
|-
| <code>FogColor</code> || <code>Color</code> || <code>1 1 1 1</code> || Color of the fog
|-
| <code>FogStart</code> || <code>Float</code> || <code>0</code> || Start of fog
|-
| <code>FogEnd</code> || <code>Float</code> || <code>2</code> || End of fog.
|-
| <code>FogFalloffExp</code> || <code>Float</code> || <code>2</code> || The fall off of the fog.
|-
| <code>FogBrightness</code> || <code>Float</code> || <code>1</code> || The HDR brightness
|-
| <code>FogUnderwater</code> || <code>Bool</code> || <code>false</code> || If the fog color should be multipled in adition to be alpha blended with geometry
|-
| <code>FogSkybox</code> || <code>Bool</code> || <code>false</code> || Should the fog color come from the skybox
|-
| <code>EffectOnExit</code> || <code>Bool</code> || <code>true</code> || If effects should be used as the camera breaches the surface of the water.
|-
| <code>CameraCollideCallback</code> || <code>Function</code> || Not specified || Callback for when the camera enters the liquid area. Syntax: void Func(int alState). alState: -1=camera left, 1=camera entered
|-
| <code>CameraEnterEffectPreset</code> || <code>String</code> || <code>""</code> || MapEffectsHandler preset to use when the camera is inside the area
|-
| <code>CameraExitEffectPreset</code> || <code>String</code> || <code>""</code> || MapEffectsHandler preset to use when the camera leaves the area
|}

== See also ==
* [[HPL3/SOMA/Areas|SOMA areas]]

== Documentation to expand ==
Creation workflow, runtime behavior and a worked map example need expansion.

[[Category:English]]

HPL3/Areas/Liquid Area - Revision history

TiMan: Add source-verified reference and identify information needing expansion.