Difference between revisions of "Rain Weather Effects"
From Wolfire Games Wiki
m (→Thunder and lightning hotspot) |
(Formatting and adding example images) |
||
| Line 26: | Line 26: | ||
# 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) | # 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> | + | # Browse to '''<code>Data/Objects/Hotspots</code>''' and select '''<code>rain.xml</code>''' |
# Your cursor will turn into a '''<code>+</code>''' symbol | # 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. | # Click somewhere in the world to place the hotspot. The location doesn't matter, since it acts globally across the level. | ||
| Line 32: | Line 32: | ||
There are no parameters for this hotspot, so you don't have to change anything at this point. | 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. Then copy the hotspot XML (<code>Data/Objects/Hotspots/rain.xml</code>) and point it at your new script. | + | '''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 == | == Ambient rain sound == | ||
This adds the constant rain sound that you hear throughout the level. | 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''' | # Spawn the new hotspot object: '''Top Bar''' -> '''Load''' -> '''Sounds''' -> '''Ambient sound hotspot''' | ||
| Line 45: | Line 47: | ||
# Drill down to find the script params, and set these values: | # Drill down to find the script params, and set these values: | ||
| − | * <code>Sound Path</code> - Set this to <code>Data/Sounds/weather/rain.wav</code> | + | === Values for Ambient sound hotspot === |
| − | * <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 | + | [[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 Max</code> - (default value of <code>10</code> is fine) | ||
* <code>Delay Min</code> - (default value of <code>3</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>Fade Distance</code> - (default value of <code>1</code> is fine) | ||
| − | * <code>Wind Scale</code> - (default value of <code>false</code> is fine | + | * <code>Wind Scale</code> - (default value of <code>false</code> is fine) |
Revision as of 19:37, 18 November 2017
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.
Contents
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.
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 (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...
(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
Data/Objects/Hotspotsand selectrain.xml - Your cursor will turn into a
+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 (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.
- Spawn the new hotspot object: Top Bar -> Load -> Sounds -> Ambient sound hotspot
- Your cursor will turn into a
+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 U key)
- Drill down to find the script params, and set these values:
Values for Ambient sound hotspot
-
Sound Path- Set this toData/Sounds/weather/rain.wav -
Gain- You might want to set it to0.5or even lower. We set ours to0.57 -
Global- (default value oftrueis fine) -
Delay Max- (default value of10is fine) -
Delay Min- (default value of3is fine) -
Fade Distance- (default value of1is fine) -
Wind Scale- (default value offalseis fine)
