View source for Rain Weather Effects

There are a total of four pieces that make up the rain weather effects that you see on a level like Tree Climb or Cave Arena.

== Rain particle effect ==

This adds the falling rain drop particles.

[[File:Rain-particles_small.gif]]

To add this, add the '''<code>GPU Particle Field</code>''' entry to the level's script parameters. Set this value to '''<code>#RAIN</code>''' (make sure you use '''upper-case''').

Here's [[Shader_And_Weather_Effects#Particles|instructions for adding a '''<code>GPU Particle Field</code>''' value]].

== Water "rain splash" shader effect ==

This adds the shimmering water layer effect to all the objects in the world. Here's an example: https://gfycat.com/gifs/detail/SplendidThisAiredaleterrier

To add this, add the '''<code>Custom Shader</code>''' entry to the level's script parameters. Set this value to '''<code>#RAINY</code>''' (make sure you use '''upper-case''', and it is '''<code>#RAINY</code>''' not '''<code>#RAIN</code>''').

Here's [[Shader_And_Weather_Effects#Weather_Effects.2FWorld_Shaders|instructions for adding a '''<code>Custom Shader</code>''' value]].

== Thunder and lightning hotspot ==

[[File:Editor-load-load-item.png|114px|thumb|'''Load item...''' menu option]]

This add the periodic light flashes and thunder clap sound (but not the ambient rain sound, in case you want to have a lightning storm going on nearby, but no rain).

To add this, use the '''Load item...''' menu option:

# Spawn the new hotspot object: '''Top Bar''' -> '''Load''' -> '''Load item...'''<br>(this will open a new window to browse for files. It may be easier to do this step if you have the game in windowed mode)
# Browse to '''<code>Data/Objects/Hotspots</code>''' and select '''<code>rain.xml</code>'''
# Your cursor will turn into a '''<code>+</code>''' symbol
# Click somewhere in the world to place the hotspot. The location doesn't matter, since it acts globally across the level.

There are no parameters for this hotspot, so you don't have to change anything at this point.

'''Note''': If you want to customize this effect, you're going to need to make your own copy of the script for that hotspot (<code>Data/Scripts/hotspots/rain.as</code>) and edit that script.<br>Then copy the hotspot XML (<code>Data/Objects/Hotspots/rain.xml</code>) and point it at your new script.

== Ambient rain sound ==

This adds the constant rain sound that you hear throughout the level.

[[File:Editor-load-sounds-ambient-sound.png|139px|thumb|'''Ambient sound hotspot''' menu option]]

# Spawn the new hotspot object: '''Top Bar''' -> '''Load''' -> '''Sounds''' -> '''Ambient sound hotspot'''
# Your cursor will turn into a '''<code>+</code>''' symbol
# Click somewhere in the world to place the hotspot. The location doesn't matter, since it acts globally across the level
# Double click on the new object to select it
# Open the object properties: '''Top Bar''' -> '''Windows''' -> '''Selected''' (or just press the '''<kbd>U</kbd>''' key)
# Drill down to find the script params, and set these values:

=== Values for Ambient sound hotspot ===

[[File:Ambient-sound-rain-hotspot-settings.png|582px|thumb|Rain sound hotspot settings]]

* '''<code>Sound Path</code>''' - Set this to '''<code>Data/Sounds/weather/rain.wav</code>'''
* '''<code>Gain</code>''' - You might want to set it to '''<code>0.5</code>''' or even lower. We set ours to '''<code>0.57</code>'''
* '''<code>Global</code>''' - (default value of '''<code>true</code>''' is fine)
* <code>Delay Max</code> - (default value of <code>10</code> is fine)
* <code>Delay Min</code> - (default value of <code>3</code> is fine)
* <code>Fade Distance</code> - (default value of <code>1</code> is fine)
* <code>Wind Scale</code> - (default value of <code>false</code> is fine)