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.

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

Here's instructions for adding a GPU Particle Field value.

Stop rain in a certain area

To do that you have to go to editor mode, click in Load, and then search for Particle Occluder Hotspot, and spawn it where you want rain to not have any effect.

After that, in editor mode, press "Y" and go to Custom Shaders, here write #GPU_PARTICLE_FIELD_OCCLUSION (make sure you use upper-case).

Take in mind using this Custom shader can affect performance a bit.

Water "rain splash" shader effect

This adds the shimmering water layer effect to all the objects in the world.

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

Here's instructions for adding a Custom Shader value.

Thunder and lightning hotspot

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

Load item... menu option

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

1. Spawn the new hotspot object: Top Bar -> Load -> Load item...
   (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)
2. Browse to Data/Objects/Hotspots and select rain.xml
3. Your cursor will turn into a + symbol
4. 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 (Data/Scripts/hotspots/rain.as) and edit that script.
Then copy the hotspot XML (Data/Objects/Hotspots/rain.xml) and point it at your new script.

Ambient rain sound

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

Ambient sound hotspot menu option

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

Values for Ambient sound hotspot

Rain sound hotspot settings

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