View source for Mapdev:water

= Water =
The 'water' engine feature can be used for more than just water, it can be Lava, Slime, and completely invisible for maps in space.

Water is always at zero elevation, the terrain is positioned above and below the water using the <code>minHeight</code> and <code>maxHeight</code> values(see [[Mapdev:height]]).

Shading of the water is split into two parts; the surface of the water and the surface of the ground under the water

Water has five different rendering modes which can be set ingame by the command:
<pre>/water</pre>
<ol start=0>
<li> basic
<li> reflective
<li> dynamic
<li> reflective&refractive
<li> bumpmapped
</ol>

The relevant soure code [https://github.com/spring/spring/tree/bfc21aada48a6a606b039819ba55017fe3d4f29d/rts/Rendering/Env files]

= Specifications =
Now because of the various graphical modes, and some options being shared, I've split this into sections.

==Data Types==
{{DataTypes}}

== Options that are always relevant ==
<pre>local mapinfo = {
   ...
   tidalStrength = 0,
   voidWater = false,
   ...
   water = {
      damage =  0.0,

      absorb    = {0.0, 0.0, 0.0},
      baseColor = {0.0, 0.0, 0.0},
      minColor  = {0.0, 0.0, 0.0},

      forceRendering = false,

      planeColor = {0.0, 0.4, 0.0},
    },
   ...
}</pre>

{{tag|name=tidalStrength|type=float}}

{{tag|name=voidWater|default=false|type=bool|description=If true, the water will not be drawn. Also the terrain under the water will not be drawn.}}

{{tag|name=damage|type=float}}

{{tag|name=absorb|type=float3|description=Used to calculate the colour of the terrain under the water, see below.}}

{{tag|name=baseCcolor|type=float3|description=Used to calculate the colour of the terrain under the water, see below.}}

{{tag|name=minColor|type=float3|description=Used to calculate the colour of the terrain under the water, see below.}}

The absorb, baseColor and minColor variables are used to alter the colour of the terrain under the water as defined in a glsl shader, see [https://github.com/spring/spring/blob/a71c17d710cc387c484e876971881837ecb0ff10/cont/base/springcontent/shaders/GLSL/SMFFragProg.glsl line 163].

{{tag|name=forceRendering|default=false|type=bool|description=If false, and the minimum height of the terrain is above 1.0, then the water will not be drawn.}}

{{tag|name=planeColor|default={0.0, 0.4, 0.0}|type=float3|description=sets the colour of the horizon water plane, to prevent it from being drawn at all you must comment out this line.}}

== Basic ==
<center>
{| class="wikitable" 
|+ Example
| [[File:Water basic example.jpg|400px]]
|}</center>
<pre>local mapinfo = {
   ...
   water = {
      repeatX = 0.0,
      repeatY = 0.0,

      --texture = "",
   },
   ...
}</pre>

{{tag|name=repeatX|type=float|default=0|description=control the texture repetition}}

{{tag|name=repeatY|type=float|default=0|description=control the texture repetition}}

{{tag|name=texture|type=string|default=0|description=the texture image to use, searches the ./maps/ directory of the map archive.}}

== Reflective ==
<center>
{| class="wikitable" 
|+ Example
| {{FIXME}}need to place an image here
|}</center>
<pre>local mapinfo = {
   ...
   water = {
      surfaceColor  = {0.75, 0.8, 0.85},
   },
   ...
}</pre>

{{FIXME}}?

{{tag|name=surfaceColor|type=float3f|default={0.0, 0.0, 0.0}|description=Effects the reflected colour.}}

== Dynamic ==
<center>
{| class="wikitable" 
|+ Example
| [[file:water_dynamic_example.jpg|400px]]
|}</center>
<pre>local mapinfo = {
   ...
   water = {
      surfaceColor  = {0.75, 0.8, 0.85},
      --foamTexture =   "",
   },
   ...
}</pre>

{{tag|name=surfaceColor|type=float3f|default={0.0, 0.0, 0.0}|description=Effects the reflected colour.}}

{{FIXME}}?

== Reflective and Refractive ==
From what i can tell, this mode is basically the same as the reflective mode, except that it distorts(refracts the light) of objects under the surface.
<center>
{| class="wikitable" 
|+ Example
| [[file:water_refractive_example.jpg|400px]]
|}</center>
<pre>local mapinfo = {
   ...
   water = {
      surfaceColor  = {0.75, 0.8, 0.85},
   },
   ...
}</pre>

{{tag|name=surfaceColor|type=float3f|default={0.0, 0.0, 0.0}|description=Effects the reflected colour.}}

== Bump Mapped ==
<center>
{| class="wikitable" 
|+ Example
| {{FIXME}}need to place an image here
|}</center>
<pre>local mapinfo = {
   ...
   water = {
      ambientFactor  = 1.0,
      diffuseFactor  = 1.0,
      specularFactor = 1.0,
      specularPower  = 20.0,



      surfaceColor  = {0.75, 0.8, 0.85},
      surfaceAlpha  = 0.55,
      diffuseColor  = {1.0, 1.0, 1.0},
      specularColor = {0.5, 0.5, 0.5},

      fresnelMin   = 0.2,
      fresnelMax   = 0.8,
      fresnelPower = 4.0,

      reflectionDistortion = 1.0,

      blurBase      = 2.0,
      blurExponent = 1.5,

      perlinStartFreq  =  8.0,
      perlinLacunarity = 3.0,
      perlinAmplitude  =  0.9,
      windSpeed = 1.0, --// does nothing yet

      shoreWaves = true,

      --foamTexture =   "",
      --normalTexture = "",
      --caustics = {
      --   "",
      --   "",
      --},
      numTiles = 1,
      hasWaterPlane = true,

   },
   ...
}</pre>

{{FIXME}}?

= Forum Discussions =
* [http://springrts.com/phpbb/viewtopic.php?f=13&t=28264 chockolate rain] map discussion apparrently has soemthing in it i wanted to keep for later.. cant remember though...
* [[Water_Height:_Mapconv_vs._Heightmap|water height]]

[[Category:Map Dev]]