Wolfire Games Wiki - User contributions [en]

Portal:Receiver 2

2020-04-20T00:24:19Z

Edoantonioco: Created page with "Receiver 2 wiki"

Receiver 2 wiki

Rain Weather Effects

2019-10-26T23:22:03Z

Edoantonioco:

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-particles2_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]].

== 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 '''<code>#GPU_PARTICLE_FIELD_OCCLUSION</code>''' (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.

[[File:Rainy-shader3-z-small.gif]]

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 ==

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).

[[File:Rain-hotspot-lightning-effect.gif]]

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

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 '''<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. 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)

[[Category: Overgrowth]]
[[Category: Modding]]

Hotspots

2019-10-26T23:21:25Z

Edoantonioco:

:''This Page doesn't cover creating self-made hotspots. To read about that, see [[Hotspot Scripting]].''

Hotspots are objects that make things happen in the game in different ways. They can be used to make fire, water, kill boxes, objectives and much more.

Several hotspots can be found in the top bar under ''Load → Hotspot'', however not all hotspots can be found there. All hotspots can be found by going to ''Load → Load item...'' and browsing to ''../Overgrowth/Data/Objects/Hotspots/''.

This page lists all hotspots available in the game and what their use is.

== Hotspots ==

=== activate_characters ===
When the player enters the hotspot some NPCs has their ''static'' flag set to false. This can be used to optimize a level by having enemies be ''static'' until the player gets close to them.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! characters
| list of ints || A space-delimited list of IDs of characters which should have their ''static'' flag set to false when the player enters the hotspot
|}

Example: 5124 423 566

=== ambient_sound ===
Is used to play environment sounds, either in some specific part of the level, or in the entire level. It can be used to add creaky wood sounds only to a ship, wind sound only at the top of a mountain, rustling leaves sound only close to trees and so on.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Delay Max
| int || The maximum random time in seconds until this sound triggers after having been triggered
|-
! Delay Min
| int || Same as ''Delay Max'', except the minimum random time
|-
! Fade Distance
| int || The distance in meters outside of the hotspot that the sound should start being audible, it fades in to full volume as the camera gets closer to the hotspot
|-
! Gain
| float || How loud the sound should be
|-
! Global
| bool || If the sound should play everywhere, and not only at the hotspot's location
|-
! Sound Path
| string || The path to the sound to use, they can be found in Data/Sounds/
|-
! Wind Scale
| bool || Makes the sound increase and decrease in volume to make it feel like it's being created by wind
|}

=== boundary ===
When the player enters this hotspot's volume, they are pushed in a specific direction based on the rotation of the hotspot. Note that it only pushes horizontally, it can not push up or down. To know which direction it pushes in, simply test it by running into it.

=== displayimage ===
Renders an image in the middle of the screen when the player is inside the hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! [0] Display Image Path
| string || Location on disk of image to show
|-
! [1] Scale
| float || How large the image should be, in percent
|-
! [2a] Red Tint
| int || Multiplier for image's red channel
|-
! [2b] Green Tint
| int || Multiplier for image's green channel
|-
! [2c] Blue Tint
| int || Multiplier for image's blue channel
|-
! [2d] Alpha Tint
| int || Multiplier for image's alpha channel
|}

=== displaytext ===
Shows some text on the screen while the player is in the hotspot. Does not support word wrap or line breaks.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Display Text
| string || Text to show
|}

=== displayvideo ===
Does not work.

=== emitter ===
Creates either smoke, fog or water splashes within the hotspot volume.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Type
| string || Set it to either "Smoke", "Foggy" or "Falling Water" (without the quotes)
|}

=== eye_adjust ===
Changes the HDR settings when the player character enters the hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! HDR Black point
| float || Sets the low range of the dynamic range
|-
! HDR Bloom multiplier
| float || Changes the intensity of the bloom effect
|-
! HDR White point
| float || Sets the high range of the dynamic range
|}

=== fire_test ===
Pretty looking fire composed of a number of textured ribbons and a light source. Can ignite characters when they touch it.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Fire Ribbons
| int || The number of ribbons that should be used
|-
! Ignite Characters
| bool || If checked, characters will ignite when they touch the fire, only works on NPCs if they are ragdolled
|-
! Light Amplify
| float || The intensity of the light from the fire
|-
! Light Distance
| float || How far away the light should reach '''TODO:''' What unit is this in?
|}

=== general_campaign_level ===
'''TODO:''' How does this work?

=== generic_kill ===
Kills any character that enters the hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! KillNPC
| bool || If checked, the hotspot is lethal to NPCs
|-
! KillPlayer
| bool || If checked, the hotspot is lethal to the player
|}

=== lava_kill ===
Ignites and instantly kills any character that comes into contact with the hotspot.

=== levelwin ===
Sends a global "levelwin" message when the player enters the hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! branch
| string || After the "levelwin" message, a space is added and then this string
|}

=== loadlevel ===
Loads a specified level when the player enters the hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Level to load
| string || The path to the level you want to load, starting in ../Overgrowth/
|}

=== lugaru_hawk ===
Adds a hawk that circles around the hotspot.

=== new_checkpoint ===
A checkpoint that's used together with the [[#respawn_at_checkpoint|respawn_at_checkpoint]] hotspot. Entering this hotspot makes this the current checkpoint. When touching a [[#respawn_at_checkpoint|respawn_at_checkpoint]] you get teleported to the center of the most recently touched ''new_checkpoint'' hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! LastEnteredTime
| int || A timestamp for when this was most recently touched, this is used to determine which ''new_checkpoint'' hotspot to respawn at when touching a [[#respawn_at_checkpoint|respawn_at_checkpoint]] hotspot
|}

=== no_grab ===
Any ledge within this hotspot can't be grabbed. You would usually use the [[Collision Painting|collision painting system]] to decide whether a ledge is grabbable, but if you want to for instance make a ledge in a [[Prefabs|prefab]] not grabbable you can't always do that, so you can then use this no_grab hotspot instead.

=== object_disappear ===
Deletes the specified object when the player enters the hotspot.

Note that this hotspot does not use the actual name of the object. You need to manually add a script parameter on the object you want to delete called "Name", and write the same name you specify in "Object name to dissapear" parameter in the hotspot.

Keep in mind that this hotspot actually ''deletes'' the objects from the level, as if you would have deleted them in the editor.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Object name to dissapear
| string || Any object that has an added "Name" script parameter that is the same as the string in this parameter will be deleted
|}

=== overgrowth_level ===
The hotspot used in the Overgrowth story to set goals and/or layered music within a level. All the Information for this Hotspot can be found on the ''[[Checkpoints]]'' page.

'''TODO:''' Should another hotspot be used instead of this one?

'''TODO:''' These level messages are handled in this hotspot, need to explain what that means:
<pre>
"reset"
"level_event music_layer_override"
"level_event crowd_override"
"level_event set_camera_dof"
"level_event character_knocked_out"
"level_event character_died"
"player_entered_checkpoint_fall_death"
"player_entered_checkpoint"
</pre>

=== overgrowth_level_checkpoint ===
The checkpoints used in the Overgrowth story to activate a ''"reach"'' goal. All the Information about this Hotspot can be found on the ''[[Checkpoints]]'' page.
'''TODO:''' Should another hotspot be used instead of this one?

=== Particle Occluder Hotspot ===

Allows for particles to not have any effect in the area inside the hotspot.

It works by default with particles generated by the emitter hotspot (as an example), but to make it work for rain/snow/other gpu particles, go to editor mode, press "Y" and go to Custom Shaders, here write '''<code>#GPU_PARTICLE_FIELD_OCCLUSION</code>'''

=== portal ===
Allows for traveling bwtween levels. Requires a [[#portal_manager|portal_manager]] hotspot to function properly.

You can specify a light that gets brighter as a character approaches the portal.

To be able to travel to this portal from another level you need to create a ''Load → Utility → Player Spawn'' object.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Level to load
| string || The path to the level to load when entering this hotspot
|-
! light_id
| int || The ID of the dynamic_light_object that should get brighter when a character gets closer to the hotspot
|-
! spawn_point
| int || The ID of the ''Player Spawn'' object you want the player to spawn at when teleporting to this level
|}

=== portal_manager ===
Required when using the portal hotspot.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Level to load
| int list || The IDs of all portals in the level
|}

=== resetcharacter ===
Resets any character that touches this hotspot to their spawn location.

=== resetlevel ===
Resets the level when the player touches it, as if you press L in the editor.

=== respawn_at_checkpoint ===
Used together with the [[#new_checkpoint|new_checkpoint]] hotspot. When the player touches this hotspot they get teleported to the center of the most recently touched [[#new_checkpoint|new_checkpoint]].

=== soak_level ===
After the player enters the hotspot, a new level is loaded after a set amount of time.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! next_level
| string || The path to the level to load
|-
! time_to_next_level
| int || Number of seconds to wait before loading the next level
|}

=== spike ===
A spike that can impale characters.

=== start_dialogue ===
Allows for dialogues to be started in different ways when the player is in the hotspot. For more information about dialogues read the [[Dialogue]] article.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Automatic
| bool || The dialogue starts automatically when the player enters the hotspot
|-
! Color
| RGB floats || '''TODO:''' What does this do?
|-
! Dialogue
| string || The name of the dialogue to start
|-
! Fade
| bool || Fade to black when starting the dialogue, to make transition less jarring
|-
! Visible in game
| bool || Keeps the signpost icon visible in the game
|}

=== StartRace ===
'''TODO: Does it not work like [[#FinishRace|FinishRace]] ?'''
Used to start a race similar to the one shown off in the video ''[https://www.youtube.com/watch?v=cc5L9sBF7D0|Building A Race Course In Overgrowth - Wolfire Games]''.

=== tutorial ===
Activates built-in tutorials when entered. ''Settings → Game → Tutorials'' needs to be on for the tutorials to trigger.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Type
| string || Decides which tutorial to run, can be one of the following: stealth, basic, jump_climb, walljump, jump_higher, jump_long, combat, jumpkick, knife, throw, flip_roll
|}

=== victorytrigger ===
'''TODO:''' Is this still usable? If so, how is it used?

=== water_bob ===
Makes the specified objects move as if they are on water.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Objects
| list of ints || The IDs of the objects that should be affected
|-
! SavedTransform
| Translation & rotation as floats || The original location of the objects
|-
! rotation_scale
| float || Multiplier of rotation
|-
! time_scale
| float || How fast the objects should move
|-
! translation_scale
| float || Multiplier of translation
|}

=== water_bob_fast ===
'''TODO:''' Is this simply a better optimized version of the "water_bob" hotspot?

=== wet_cube ===
A block of water with nice graphics that slows you down if you walk in it and drowns you if you're below the surface for too long.

==== Script Params ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Water Fog
| float || How far down into the water you can see
|-
! Wave Density
| float || How zoomed in the waves should be
|-
! Wave Height
| float || How strong the waves should be
|}

== Deprecated and Component Hotspots ==
These hotspots have either been replaced by a better alternative, have stopped working at some point during the development of the game, or can't be used on their own.

=== announce_items ===
Remnant from old tutorial level.

=== Checkpoint ===
No longer used, should use the new [[Checkpoints|checkpoint system]] instead.

=== collectable_target ===
Does not work anymore.

=== dark_world_level ===
Crashes the game.

=== dark_world_trigger ===
Function unknown.

=== destination_trail ===
Function unknown.

=== FinishRace ===
No longer works. Used in the Video ''[https://www.youtube.com/watch?v=cc5L9sBF7D0|Building A Race Course In Overgrowth - Wolfire Games]''.

=== fixedragdollpart ===
Not used on its own, used in aschar for impaling.

=== kill ===
Deprecated, use the [[#generic_kill|generic_kill]] or [[#lava_kill|lava_kill]] hotspots instead.

=== lugaru_level ===
The level hotspot used in the official Lugaru story.

=== must_visit_trigger ===
Old unused challenge hotspot.

=== particle_foggy ===
This is actually not a hotspot, it just creates an emitter hotspot that's pre-configured as fog.

=== rain ===
Particle based rain, use the [[Shader And Weather Effects|rain shaders]] instead.

=== spike_tip ===
Used by the spike hotspot.

=== snow ===
Particle based snow, use the [[Shader And Weather Effects|snow shaders]] instead.

=== water ===
Deprecated, use [[#wet_cube|wet_cube]] instead.

[[Category: Overgrowth]]
[[Category: Modding]]

Rain Weather Effects

2019-10-26T23:16:07Z

Edoantonioco:

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-particles2_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]].

== 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 '''<code>#GPU_PARTICLE_FIELD_OCCLUSION</code>''' (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.

[[File:Rainy-shader3-z-small.gif]]

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 ==

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).

[[File:Rain-hotspot-lightning-effect.gif]]

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

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 '''<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. 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)

[[Category: Overgrowth]]
[[Category: Modding]]

Rain Weather Effects

2019-10-26T23:15:40Z

Edoantonioco:

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-particles2_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]].

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

== 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 '''<code>#GPU_PARTICLE_FIELD_OCCLUSION</code>''' (make sure you use '''upper-case''')

== Water "rain splash" shader effect ==

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

[[File:Rainy-shader3-z-small.gif]]

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 ==

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).

[[File:Rain-hotspot-lightning-effect.gif]]

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

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 '''<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. 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)

[[Category: Overgrowth]]
[[Category: Modding]]

Rain Weather Effects

2019-10-26T23:14:50Z

Edoantonioco:

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-particles2_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]].

== 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 '''<code>#GPU_PARTICLE_FIELD_OCCLUSION</code>''' (make sure you use '''upper-case''')

== Water "rain splash" shader effect ==

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

[[File:Rainy-shader3-z-small.gif]]

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 ==

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).

[[File:Rain-hotspot-lightning-effect.gif]]

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

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 '''<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. 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)

[[Category: Overgrowth]]
[[Category: Modding]]

Shader And Weather Effects

2019-10-26T23:08:52Z

Edoantonioco: gpu occluder thing

[[Category: Modding]]
[[Category: Overgrowth]]

'''TODO''': Add embedded screenshots and/or gifs/webms for all these effects to show what they look like.

==Particles==

===Create and set the <code>GPU Particle Field</code> level script parameter===

# Open a level
# Launch the editor (<kbd>F1</kbd> key. You may have to hold the <kbd>FN</kbd> and/or <kbd>SHIFT</kbd> key to get this to work)
# Open the Scenegraph properties ('''Windows''' -> '''Scenegraph''' or the <kbd>Y</kbd> key)
# Expand <code>Level</code>
# Expand <code>Script Params</code>
# If you do not see <code>GPU Particle Field</code> in the list, click the '''New parameter''' button
# Double click where it says <code>Untitled parameter</code>
# Type <code>GPU Particle Field</code> and hit <kbd>ENTER</kbd>

Make sure to remove this parameter if you're not using it, or you'll see a bunch of non-moving particles floating throughout the world.

===Set the value of <code>GPU Particle Field</code> to some of these tags===

Separate multiple tags using spaces.

'''Note''': These parameters are '''case sensitive'''. They must be in upper case, or they will not work!

: <code>#ASH</code> - Falling ash, rising smoke, and flying ember particles 
: <code>#BUGS</code> - Flying bug particles 
:: <code>#MOREBUGS</code> - Increase the amount of bugs (must also define #BUGS to use this) 
:: <code>#FIREFLY</code> - Flying glowing bug particles (must also define #BUGS to use this) 
::: <code>#WATER_DELETE</code> - Make fireflies not appear under water (must also define #FIREFLY to use this) 
: <code>#RAIN</code> - Falling rain particles (see [[RainWeatherEffects|these instructions for how to make this effect more dramatic]]) 
: <code>#SNOW</code> - Falling snow particles 
:: <code>#MED</code> - Decrease the amount of snow particles (must also define #SNOW to use this) 

==Weather Effects/World Shaders==

===Create and set the <code>Custom Shader</code> level script parameter===

# Open a level
# Launch the editor (<kbd>F1</kbd> key. You may have to hold the <kbd>FN</kbd> and/or <kbd>SHIFT</kbd> key to get this to work)
# Open the Scenegraph properties ('''Windows''' -> '''Scenegraph''' or the <kbd>Y</kbd> key)
# Expand <code>Level</code>
# Expand <code>Script Params</code>
# If you do not see <code>Custom Shader</code> in the list, click the '''New parameter''' button
# Double click where it says <code>Untitled parameter</code>
# Type <code>Custom Shader</code> and hit <kbd>ENTER</kbd>

===Set the value of <code>Custom Shader</code> to some of these tags===

Separate multiple tags using spaces.

'''Note''': These parameters are '''case sensitive'''. They must be in upper case, or they will not work!

: <code>#ADD_MOON</code> - Adds glowing orb into sky (sky must be dark enough for you to see it, and can be obscured by a "sun" with a visible intensity) 
: <code>#ADD_STARS</code> - Adds twinkling dots into sky (sky must be dark enough for you to see them) 
: <code>#BEACH</code> - Adds glistening wetness to ground, and water caustics 
: <code>#CAVE</code> - Adds a haze effect, similar to what is seen in <code>#MISTY</code>, <code>MISTY2</code>, and <code>SKY_ARK</code> 
: <code>#DAMP_FOG</code> - Adds full screen rolling effect modifier to fog (must have some fog set in order to see this) 
: <code>#DIRECTED_WATER_DECALS</code> - Adds the ability to make the <code>Objects/Decals/water_froth.xml</code> water decal scroll, when modifying its green tint parameter (with <code>CTRL + P</code>) 
: <code>#EMISSIVE</code> - Makes the world fully bright (probably not great to keep in level, might be useful for detail work. Not guaranteed to not cause errors) 
: <code>#GPU_PARTICLE_FIELD_OCCLUSION</code> - Use alongside Particle Occluder Hotspot if you want snow/rain/other GPU Particle Field weather effects to not appear inside a certain area. 
: <code>#MISTY</code> - Adds a volumetric steamy haze effect (can see it even without fog, but fog makes it more visible, and the effect while there's no fog is not very realistic) 
: <code>#MISTY2</code> - Adds a volumetric rolling steamy haze effect (can see it even without fog, but fog makes it more visible, and the effect while there's no fog is not very realistic) 
: <code>#RAINY</code> - Makes characters appear wet, and adds a misty animated haze rain effect (see [[RainWeatherEffects|these instructions for how to make this effect more dramatic]]) 
: <code>#SCROLL_VERY_SLOW</code> - Uhhh creepy stuff! 
: <code>#SKY_ARK</code> - Adds glistening wetness to ground, and adds a volumetric steamy haze effect 
: <code>#SNOW_EVERYWHERE</code> - Adds a thin frost cap all over objects, a thick snow cap on the very top of them, and a thin snow cap on characters (most useful if a level is already "snowy") 
: <code>#SNOW_EVERYWHERE2</code> - Adds a thick snow cap all over objects, a thin snow cap on characters, and turns the sky into a colorful gradient (can turn a non-snowy level into a snowy one) 
: <code>#SNOW_EVERYWHERE3</code> - Adds a thick directional snow cap partially covering objects, and a thin snow cap on characters (can turn a non-snowy level into a snowy one) 
: <code>#SWAMP</code> - Adds a slimy coating to everything, and makes rainbows appear 
: <code>#TEST_CLOUDS_2</code> - Switches the sky box to a moving cloud texture, and projects cloud shadows onto the ground/objects 
:: <code>#MORECLOUDS</code> - Increases the density of the clouds (must also define #TEST_CLOUDS_2 to use this) 
:: <code>#CLOUDS_DO_NOT_TINT_SKY</code> - Uses the skybox behind the clouds, instead of tinting the sky with a solid color (must also define #TEST_CLOUDS_2 to use this) 
:: <code>#CLOUDS_ALPHA</code> - Makes clouds do alpha blending against the sky map, instead of an opaque overlay (must also define #TEST_CLOUDS_2 to use this) 
:: <code>#CLOUDS_BELOW_HORIZON</code> - Makes clouds appear below the horizon instead of above it - level is "over the clouds" (must also define #TEST_CLOUDS_2 to use this) 
:: <code>#CLOUDS_DO_NOT_CAST_SHADOWS</code> - Gets rid of cloud shadows that are cast on the world - useful if clouds are below horizon (must also define #TEST_CLOUDS_2 to use this) 
:: <code>#CLOUDS_VORTEX</code> - Makes the clouds swirl into a point in the center of the level, like the eye of a storm (must also define #TEST_CLOUDS_2 to use this) 
: <code>#VOLCANO</code> - Adds a red underglow shader on the world and objects, and adds a heat haze effect 
:: <code>#LESS_SHIMMER</code> - Reduces the heat haze effect slightly (must also define #VOLCANO to use this) 
: <code>#WATER_HORIZON</code> - Makes ground and objects above a certain level appear wet, and adds distant fog to make water appear to extend off all the way to the horizon 
:: <code>#ALT</code> - Raises the water level, and extends the fog/horizon distance 
: <code>#WATERFALL_ARENA</code> - Makes foam texture scroll, adds foggy haze, and makes rainbows appear. Use <code>#CAVE</code> at the same time to remove the rainbows and change the fog a bit

Portal:Overgrowth

2018-04-07T03:23:33Z

Edoantonioco: /* Asset Creation */

<noinclude>[[Category:Portals|{{PAGENAME}}]] [[Category:Overgrowth|{{PAGENAME}}]] </noinclude>
{{Overgrowth Portal Header}}

-----

[http://www.wolfire.com/overgrowth Overgrowth] is a cross-platform game developed by Wolfire Games, an independent game development company. Overgrowth is the spiritual successor to [[Lugaru]], an earlier game also developed by Wolfire. Development of Overgrowth was officially announced on September 17th, 2008, and version 1.0 was officially released on October 16th, 2017. The game is currently purchasable via [http://www.wolfire.com/overgrowth/preorder direct order], through [https://www.humblebundle.com/store/overgrowth Humble Bundle], and [http://store.steampowered.com/app/25000/Overgrowth/ Steam].

Overgrowth's Gameplay emphasizes fluid, fast-paced, 3rd-person perspective armed and unarmed melee combat, 3D-platforming, and stealthy infiltration. Overgrowth uses a custom game engine codenamed "[[Phoenix Engine|Phoenix]]", and a lot of work has been put into making it accessible to [[Editor_Interface|modding]].

The game currently consists of two campaigns - a remastering of Lugaru in the Phoenix engine, and its successor, the new Overgrowth campaign, as well as a collection of maps (many of which are populated by enemies) which the player is able to explore, fight through, and even modify if they are so inclined. There are three additional gameplay modules, one called "Arena", in which the player is pitted against procedurally generated NPC enemies in gladiatorial matches, and "Versus," a two-player local competitive mode in which you can fight your friends, or enemies! There are also numerous player-made characters, weapons, maps, campaigns, and gameplay modifications available through the [https://steamcommunity.com/app/25000/workshop/ Steam Workshop], and a community-made tool called the [http://forums.wolfire.com/viewtopic.php?f=13&t=14201 SUMlauncher].

The story of Overgrowth features a continuation of [[Turner]]'s journey, 1 year after the events of [[Lugaru]]. In addition to anthropomorphic rabbits and wolves, the Overgrowth Universe now includes cats, dogs, and rats (see article: [[Races]]), all of whom appear in the main campaign.

== Playing and Configuring Overgrowth ==
* [[Getting Started]]
* [[Control Reference]]
* [[Configuring Overgrowth]]
* [[Overgrowth FAQ]]

== The Overgrowth Universe ==
* [[Races]]
* [[Locations]]
* [[Characters (lore)]]
* [[Equipment and Weapons]]
* [[Lore]]

== Phoenix Engine Documentation ==

Here we aim to provide comprehensive documentation about all features relevant to modding and level editing.

=== General ===
* [[Creating a new Mod]]

=== Level Editing ===
* [[Editor Interface]]
* [[Overgrowth Levels | Setting Up a Level - XML Files]]
* [[Prefabs]]
* [[Custom Terrain | Choosing or Creating Terrain]]
* [[Lighting]]
* [[Script Parameters]]
* [[Characters]]
* [[Weapons]]
* [[NPC Navigation]]
* [[Hotspots]]
* [[Dialogue Editor]]
* [[Checkpoints]]
* [[Shader And Weather Effects]]
** [[Rain Weather Effects]]
* [[LevelScripts]]

=== Asset Creation ===
* [[3D Objects]]
* [[Custom Terrain]]
* [[Custom Weapons]]
* [[Character Models]]
* [[Custom Animations]]
* [[Custom Attacks]]
* [[Particle Effects]]
* [[Custom Decals]]
* [[Binary File Formats]]
* [[Shader Creation]]

=== Tutorials ===
* [[Making a Pitch Black Level]]
* [[Making New Models & Textures]]
* [[Dialogue]]

=== Scripting ===
* [[Scripting]]
* [[Common Script External Code]]
* [[Hotspot Scripting]]
** [[Level Script External Code|Hotspot Script External Code]]
* [[LevelScripts]]
** [[Level Script External Code]]
* [[Character Scripting]]
** [[Character Script External Code]]
* [[Editor Camera]]
** [[Editor Camera Script External Code]]

== Misc ==
* [[Useful Links]]
* [[Supported Video Cards]]
* [[Overgrowth_Linux|Linux]]
* [[Alpha List]]
* [[Overgrowth tests]] {{stub}}
* [[Post Processing Effects]]

Checkpoints

2018-03-30T22:40:15Z

Edoantonioco: /* Using the checkpoint system */

Checkpoints allow you to set up goals that the player can achieve to advance progress in a level.

With them you can move the player spawn point upon death and allow defeated enemies to remain dead.

When the player advances progress, you can do nothing, play a dialogue, spawn new enemies, or trigger a level win (load the next level).

You can make some of the checkpoints optional, so player progress is saved, but the player does not have to touch them to complete the level.

== Using the checkpoint system ==

Start by creating a new level, or opening an existing level, and activating the editor by hitting <kbd>'''F1'''</kbd>.

You might want to enable the debug window <code>'''Windows → Debug Window'''</code> so you can see which is the current checkpoint, shown as <code>'''progress: #'''</code>.

'''Debug keys (these will work once a level has checkpoints):'''

{| class="wikitable" border="1"
|-
|L
|reset the level to the currently achieved checkpoint
|-
|K
|swap to the next checkpoint, or wrap around to the first (remember to hit <kbd>'''L'''</kbd> after to reset)
|}

'''To add the checkpoint system to a level:'''

'''Load''' -> '''Load Item...''' -> <code>'''Data/Objects/Hotspots/overgrowth_level.xml'''</code>

After this, set goals, and possibly pre/post goal actions.

== Goals ==

Goals must be accomplished by the player, in order.

Some goals are optional, in which case the player may defeat later goals, and these goals will be considered "accomplished".

The table below shows the types of goals that can be used as checkpoints. Below the table are instructions for how to use each goal.

{| class="wikitable" border="1"
|-
|[[#reach goal|reach]]
|when touched, moves the player spawn point and saves defeated enemies. must touch it to complete the level/advance progress
|-
|[[#reach_skippable goal|reach_skippable]]
|same as "reach" goal but the player never has to reach it to complete the level/advance progress
|-
|[[#defeat goal|defeat]]
|the player must defeat a list of enemies to complete the level/advance progress
|-
|[[#defeat_optional goal|defeat_optional]]
|the player may defeat a list of enemies to advance progress. If a further goal is accomplished first, these enemies are considered "defeated" when the character respawns
|-
|[[#spawn_defeat goal|spawn_defeat]]
|same as "defeat" goal but the enemies to defeat are spawned when that becomes the current goal (or on reset)
|-
|[[#no_delay_modifier|no_delay]]
|this is a modifier that reduces the time of the current goal_post or next goal_pre being triggered.
|}

=== reach goal ===

# Add the checkpoint hotspot to the scene. This is the trigger for the checkpoint. '''Load''' -> '''Load Item...''' -> <code>'''Data/Objects/Hotspots/overgrowth_level_checkpoint.xml'''</code>
# Add the placeholder object to the scene. This is the player spawn. '''Load''' -> '''Utility''' -> '''Placeholder'''
# Set the checkpoint hotspot <code>'''checkpoint_id'''</code> parameter to a value starting at <code>'''0'''</code> and ''increasing by 1'' for each checkpoint you add
# Set the checkpoint hotspot <code>'''level_hotspot_id'''</code> parameter to the ''object id'' of the overgrowth_level hotspot
# Add a <code>'''goal_<number>'''</code> parameter to the overgrowth_level hotspot and set the value to <code>'''reach <number>'''</code>, with the number from step 3
# Add a value to the overgrowth_level hotspot <code>'''player_spawn'''</code> parameter, delimited with spaces, with the id of the placeholder object from step 2 (<code>437 243 121</code>). The order matters, and the id for checkpoint 0 should go in the first spot, checkpoint 1 in the second spot, etc. You can see that you've written the correct ID if a transparent character model appears in the placeholder hotspot.

The numbers in checkpoints are tricky to get right. To add an additional checkpoint:

# Add another goal param to the overgrowth_level hotspot, and give it a number one higher than the previous goal. So if your previous goal was <code>goal_0</code>, you would add another one with the name <code>'''goal_1'''</code>
# Set the goal param's value to one higher than the previous goal. So if the previous one was <code>'''reach 5'''</code>, this new param's value would be <code>'''reach 6'''</code>
# Load a checkpoint object, and set its <code>'''checkpoint_id'''</code> parameter to a value that matches the reach goal in step #2. So, if the goal is <code>'''reach 6'''</code>, then this would just be <code>'''6'''</code>
# Set the checkpoint object's <code>'''level_hotspot_id'''</code> param
# Load a placeholder object for the player to spawn at
# Add the id of the placeholder object to the end of the overgrowth_level's <code>'''player_spawn'''</code> param. So if it was previously <code>'''123 456'''</code> then it would now be something like <code>'''123 456 784'''</code>

=== reach_skippable goal ===

Do all the same as a "reach" hotspot, but in step 5 set the value to <code>'''reach_skippable <number>'''</code> instead of <code>'''reach <number>'''</code>

=== defeat goal ===

# Add an enemy to the level
# Add a <code>'''goal_<number>'''</code> parameter to the overgrowth_level hotspot and set the value to <code>'''defeat <number>'''</code>, with the object id of the enemy from step 1
# Add additional enemy ids in the form of <code>'''defeat <some_enemy_id> <other_enemy_id>'''</code>, just like in step two (e.g. <code>defeat 4 72 8</code>)

=== defeat_optional goal ===

Do all the same as a [[#defeat goal|defeat goal]], but in step 2 set the value to <code>'''defeat_optional <numbers...>'''</code> instead of <code>'''defeat <numbers...>'''</code>

=== spawn_defeat goal ===

Do all the same as a [[#defeat goal|defeat goal]], but in step 2 set the value to <code>'''spawn_defeat <numbers...>'''</code> instead of <code>'''defeat <numbers...>'''</code>

=== no_delay modifier ===
Removes some of the delay between when an objective is completed and when the next step is started. '''TODO: How/when is this useful?'''

# Add a <code>'''goal_<number>'''</code> action to the overgrowth_level hotspot
# Add <code>'''no_delay'''</code> to the <code>'''goal_<number>'''</code> Script Param's value slot, after the specified goal and a space.
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2 || defeat 363 '''no_delay'''
|}
'''Note:''' If you don't specify a <code>'''goal_<number>_post'''</code> action, the modifier will shorten the time to the next <code>'''goal_<number>_pre'''</code> action instead.

== Pre/post goal actions ==

You can trigger an action to happen, either when a goal is set as the "current" goal, or after a goal has been accomplished.

Goal actions can be combined with each other. Just put a space between them (e.g. <code>'''activate 537 dialogue ShopkeeperBanter'''</code>). Make sure to put them in the order you want them to happen (if that's important).

Here's a list of actions that can be triggered:

{| class="wikitable" border="1"
|-
|[[#activate action|activate]]
|make a character with the given id active. This removes the "static" flag from the character. Useful for reducing CPU utilization for characters you haven't reached yet
|-
|[[#enable.2Fdisable_actions|enable]]
|enable a game object with the given id. This can be any object type, not just a character. This will make it appear in game and activate its behavior
|-
|[[#enable.2Fdisable_actions|disable]]
|disable a game object with the given id. This can be any object type, not just a character. This will make it disappear in game and deactivate its behavior
|-
|[[#dialogue action|dialogue]]
|play a dialogue with the given dialogue name
|-
|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions|dialogue_fade]]
|same as <code>'''dialogue'''</code> action but the dialogue is faded in/out at the beginning and end (except on reset). Useful to make dialogue "teleportation" feel less jarring
|-
|[[#dialogue_fade_.26_dialogue_fade_if_not_hostile_actions|dialogue_fade_if_not_hostile]]
|same as <code>'''dialogue_fade'''</code> action but the dialogue is not triggered at all if you're currently still in combat. Useful to prevent enemys from attacking the player while in dialogue
|-
|[[#play_success_sting_action|play_success_sting]]
|play the success music track, since this was a particularly challenging goal. Usually done on a <code>'''goal_N_post'''</code> action
|-
|[[#music_layer_override_action|music_layer_override]]
|force play of the given music track layer
|}

=== activate action ===

This action is mostly useful for <code>'''goal_<number>_pre'''</code> actions, so you can activate static characters right before you come to them and interact with them. It is best used to conserve CPU power when more than 3 or 4 characters are in level.

You can use these both for both enemies and allies, so you don't have to have this character in a [[#defeat goal|defeat goal]] in order to use it.

You can combine this with other actions.

'''Instructions:'''

# Add an NPC to the level (friend or enemy)
# Set up the NPC with a [[#defeat goal|defeat goal]] (optional, if this is an enemy you want to have to defeat this goal)
# Add a <code>'''goal_<number>_pre'''</code> parameter to the overgrowth_level hotspot and set the value to <code>'''activate <number>'''</code>, with the object id of the NPC from step 1. The character will be activated just a this goal as set as the active goal.
# Repeat 1 and 3 for as many characters as you want, separated with spaces, with a new <code>activate</code> action for each (i.e. <code>'''goal_3_pre'''</code>: <code>'''activate 127 activate 543'''</code>)

=== enable/disable actions ===

These actions are useful for <code>'''goal_<number>_pre'''</code> and <code>'''goal_<number>_post'''</code> actions, so you can enable objects (or characters) right before you come to them, or disable them at the end of a dialogue.

(You could use them as <code>'''goal_<number>_post'''</code> actions, if it makes sense to, but I'm not sure if that's going to be useful as frequently)

You can use these for any type of object, so you don't need any particular goal type (e.g. a [[#defeat goal|defeat goal]]) in order to use this.

You can combine these with other actions.

'''Instructions:'''

# Spawn an object to the level (any kind)
# Set up the goal that you want to this object to be "enabled/disabled" by (it appears/disappears in level as soon as the goal is set to be active)
# Add a <code>'''goal_<number>_pre'''</code> parameter to the overgrowth_level hotspot and set the value to <code>'''enable <number>'''</code> or <code>'''disable <number>'''</code>, with the object id from step 1. The object will be enabled/disabled (appear/disappear in level) just a this goal is set as the active goal.
# Repeat 1 and 3 for as many objects as you want, separated with spaces, with a new <code>enable</code> or <code>disable</code> action for each (i.e. <code>'''goal_3_pre'''</code>: <code>'''enable 127 enable 543 disable 443'''</code>)

=== dialogue action ===

This action is useful for both <code>'''goal_<number>_pre'''</code> and <code>'''goal_<number>_post'''</code> actions, so you can activate dialogues both to describe a goal when you get to it, and when a goal is completed.

'''Note:''' For a <code>'''goal_<goalnumber>_pre'''</code> action, the last two lines of dialogue will be started again if you die and respawn. The player will also be placed wherever the dialogue placed them, rather than at their spawn point.

You can combine this with other actions.

'''Instructions:'''

# Add a dialogue to the level and get it working with the dialogue editor. Note that the dialogue can affect the player's spawn point, so put the character where you want them to be after the dialogue finishes
# Set up the goal that you want this dialogue to be triggered by
# Add a <code>'''goal_<goalnumber>_pre'''</code> (or <code>'''goal_<number>_post'''</code>) parameter to the overgrowth_level hotspot and set the value to <code>'''dialogue <dialoguename>'''</code>. The dialoguename parameter should be set to dialogue name from step 1. The goalnumber parameter is goal from step 2 that you want the dialogue to be triggered before (or after).

'''To trigger a dialogue just after achieving a checkpoint goal (whether a "reach" or "defeat" checkpoint):'''

Do all the same as a dialogue triggered before progressing to a given checkpoint, but name the parameter <code>'''goal_<number>_post'''</code> (e.g. <code>'''goal_5_post'''</code>)

==== dialogue_fade & dialogue_fade_if_not_hostile actions====

Do all the same steps as for the [[#dialogue_action|dialogue action]], but at step 3 add <code>'''dialogue_fade <dialoguename>'''</code> or <code>'''dialogue_fade_if_not_hostile <dialoguename>'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue <dialoguename>'''</code>.

===play_success_sting action===

This action is useful as a <code>'''goal_<number>_post'''</code> action if the goal was particulary difficult to accomplish. It will play music that indicates success to the player.

'''Note:''' The success sting is different depending on the music specified in the overgrowth_level hotspot.

You can combine this with other actions.

'''Instructions:'''

# Set up the goal that you want this action to be triggered by
# Add a <code>'''goal_<number>_post'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''play_success_sting'''</code>.

=== music_layer_override action ===

With this action you can set the music layer, tell the game to decide the layer based on activity in the level (is the player in combat or not?) or mute the music.

'''Note:''' You can't change the music track specified with the <code>music</code> script parameter in the overgrowth_level hotspot with this acton unless you add layers to a given track. '''TODO: Should this be written here?'''

You can combine this with other actions.

'''possible <code>music_layer_override <layer></code> values:'''
{| class = wikitable
!0, 1, 2, 3, 4
| Sets the music layer (higher means more intense)
|-
! -1
| Tells the game to set the music layer based on activity in the level
|-
! -2
| Mutes the music
|}

'''Instructions:'''

# Set up the goal that you want this action to be triggered by
# Add a <code>'''goal_<number>_<post or pre>'''</code> parameter to the overgrowth_level hotspot for the goal you want to add the success sting to and set the value to <code>'''music_layer_override <layer>'''</code>, where <code>'''<layer>'''</code> is the number of the music layer you want to be played (see table above).

== Troubleshooting ==

=== General ===

Make sure you don't use a <code>start_dialogue</code> hotspot on top of the player's spawn. Doing this will likely break the checkpoint system.

If you need to start a dialogue at the beginning of the level, use a <code>goal_0_pre</code> instead, with a value of <code>dialogue '''"dialogue name here"'''</code>. Make sure you're setting the dialogue's name in the dialogue editor, and not in the script params or <code>"Selected"</code> window.

=== overgrowth_level_checkpoint ===

Open up all of your <code>overgrowth_level_checkpoint</code> instances, and look at the script parameters for them.

* Make sure that <code>checkpoint_id</code> starts at zero, and increases by 1 (''and only by 1'') for each subsequent checkpoint. This will be true even if the first <code>reach</code> goal isn't <code>goal_0</code>!
* Make sure that <code>reach '''N'''</code> values match the values for <code>checkpoint_id</code>.

[[File:Example_checkpoint_id_and_reach_goal_index.jpg|400px|thumb|none|Example of matching up "reach" and "hotspot_id" values]]

=== overgrowth_level ===

Open up the script parameters for the <code>overgrowth_level</code> instance, and look at the script parameters.

* The goals should start at <code>goal_0</code>, not at <code>goal_1</code>.
* Look at the <code>player_spawn</code> property. Count up the number of Ids in there (separated with spaces), and count up the number of <code>reach</code> goals you have. Those should be the same count.
* Make sure that each <code>player_spawn</code> id corresponds to a placeholder object in the world, and that you see a turner in a T-Pose inside each of them (which means that you typed them correctly in the <code>player_spawn</code> field).

[[File:Example_player_spawn_for_checkpoints.jpg|400px|thumb|none|Example of matching up <code>player_spawn</code> and placeholder object id values]]

[[Category: Tutorials]]
[[Category: Modding]]
[[Category: Overgrowth]]

Shader Creation

2018-01-29T18:39:02Z

Edoantonioco: /* How Overgrowth currently handle Shaders */

[[Category: Modding]]
[[Category: Overgrowth]]

==How a shader works==

Usually, shaders are compound of 2 files: the .frag and the .vert. But most of the time, the relevant information is set on the .frag file.

Overgrowth doesnt support this approach anymore, all the existing shaders on Overgrowth are stored on "Data/GLSL/Envobject.*".

==How Overgrowth currently handle Shaders==

Right now the engine automatically substitutes certain shader strings with a different/expanded string with extra options in place.

This means, even if seems to be that an object is using one of the shaders set inside Data/GLSL, the truth is that the engine is replacing it with another path making a reference to the shader created on envobject.
For example:

"cubemap" -> "envobject #TANGENT"

"cubemapobj" or "cubemapobjchar" or "cubemapobjitem" -> "envobject"

"cubemapalpha" -> "envobject #TANGENT #ALPHA"

"plant" or "plant_less_movement" -> "envobject #TANGENT #ALPHA #PLANT"

"plant_foliage" -> "envobject #TANGENT #ALPHA #PLANT #NO_DECALS"

"detailmap4" -> "envobject #DETAILMAP4 #TANGENT"

"detailmap4tangent" -> "envobject #DETAILMAP4 #TANGENT #BASE_TANGENT"

"MagmaFloor" -> "envobject #MAGMA_FLOOR"

"MagmaFlow" -> "envobject #MAGMA_FLOW"

==Creation of your custom shader==

To create or modify an existing shader:

# Copy the Envobject.* files and paste them on Data/GLSL folder inside your mod.
# Rename the envobject files to another name so it wont conflict with those from the game (we will use EnvobjectEx.* on this guide).
# Set the name of your shader. On this case our name will be <code>CUSTOM_SHADER</code>
# Write somewhere on the file your shader code by setting it inside an "if" statement.
For example: <code>#ifdef CUSTOM_SHADER</code>
and then close it with <code>#endif</code>
# Now, you can easily put your shader to work on any object very easily. Just go to your object .XML file, and inside the ShaderName tags, set something like this
<ShaderName>EnvobjectEx #CUSTOM_SHADER</ShaderName>
And now your shader will be used on that object.

Shader Creation

2018-01-26T19:28:33Z

Edoantonioco: /* Creation of your custom shader */

[[Category: Modding]]
[[Category: Overgrowth]]

==How a shader works==

Usually, shaders are compound of 2 files: the .frag and the .vert. But most of the time, the relevant information is set on the .frag file.

Overgrowth doesnt support this approach anymore, all the existing shaders on Overgrowth are stored on "Data/GLSL/Envobject.*".

==How Overgrowth currently handle Shaders==

Right now
The engine automatically substitutes certain shader strings with a different/expanded string with extra options in place.

This means, even if seems to be that an object is using one of the shaders set inside Data/GLSL, the truth is that the engine is replacing it with another path making a reference to the shader created on envobject.
For example:

"cubemap" -> "envobject #TANGENT"

"cubemapobj" or "cubemapobjchar" or "cubemapobjitem" -> "envobject"

"cubemapalpha" -> "envobject #TANGENT #ALPHA"

"plant" or "plant_less_movement" -> "envobject #TANGENT #ALPHA #PLANT"

"plant_foliage" -> "envobject #TANGENT #ALPHA #PLANT #NO_DECALS"

"detailmap4" -> "envobject #DETAILMAP4 #TANGENT"

"detailmap4tangent" -> "envobject #DETAILMAP4 #TANGENT #BASE_TANGENT"

"MagmaFloor" -> "envobject #MAGMA_FLOOR"

"MagmaFlow" -> "envobject #MAGMA_FLOW"

==Creation of your custom shader==

To create or modify an existing shader:

# Copy the Envobject.* files and paste them on Data/GLSL folder inside your mod.
# Rename the envobject files to another name so it wont conflict with those from the game (we will use EnvobjectEx.* on this guide).
# Set the name of your shader. On this case our name will be <code>CUSTOM_SHADER</code>
# Write somewhere on the file your shader code by setting it inside an "if" statement.
For example: <code>#ifdef CUSTOM_SHADER</code>
and then close it with <code>#endif</code>
# Now, you can easily put your shader to work on any object very easily. Just go to your object .XML file, and inside the ShaderName tags, set something like this
<ShaderName>EnvobjectEx #CUSTOM_SHADER</ShaderName>
And now your shader will be used on that object.

Shader Creation

2018-01-26T19:27:43Z

Edoantonioco: /* How Overgrowth currently hande Shaders */

[[Category: Modding]]
[[Category: Overgrowth]]

==How a shader works==

Usually, shaders are compound of 2 files: the .frag and the .vert. But most of the time, the relevant information is set on the .frag file.

Overgrowth doesnt support this approach anymore, all the existing shaders on Overgrowth are stored on "Data/GLSL/Envobject.*".

==How Overgrowth currently handle Shaders==

Right now
The engine automatically substitutes certain shader strings with a different/expanded string with extra options in place.

This means, even if seems to be that an object is using one of the shaders set inside Data/GLSL, the truth is that the engine is replacing it with another path making a reference to the shader created on envobject.
For example:

"cubemap" -> "envobject #TANGENT"

"cubemapobj" or "cubemapobjchar" or "cubemapobjitem" -> "envobject"

"cubemapalpha" -> "envobject #TANGENT #ALPHA"

"plant" or "plant_less_movement" -> "envobject #TANGENT #ALPHA #PLANT"

"plant_foliage" -> "envobject #TANGENT #ALPHA #PLANT #NO_DECALS"

"detailmap4" -> "envobject #DETAILMAP4 #TANGENT"

"detailmap4tangent" -> "envobject #DETAILMAP4 #TANGENT #BASE_TANGENT"

"MagmaFloor" -> "envobject #MAGMA_FLOOR"

"MagmaFlow" -> "envobject #MAGMA_FLOW"

==Creation of your custom shader==

To create or modify an existing shader:

# Copy the Envobject.* files and paste them on Data/GLSL folder inside your mod.
# Rename the envobject files to another name so it wont conflict with those from the game (we will use EnvobjectEx.* on this guide).
# Set the name of your shader. On this case our name will be <code>CUSTOM_SHADER</code>
# Write somewhere on the file your shader code by setting it inside an "if" statement.
For example: <code>#ifdef CUSTOM_SHADER</code>
and then close it with <code>#endif</code>
# Now, you can easily put your shader to work on any object very easily. Just go to your object .XML file, and inside the ShaderName tags, set something like this
<ShaderName>EnvobjectEx #CUSTOM_SHADER</ShaderName>
And now your shader will work.

Shader Creation

2018-01-26T19:15:16Z

Edoantonioco:

[[Category: Modding]]
[[Category: Overgrowth]]

==How a shader works==

Usually, shaders are compound of 2 files: the .frag and the .vert. But most of the time, the relevant information is set on the .frag file.

Overgrowth doesnt support this approach anymore, all the existing shaders on Overgrowth are stored on "Data/GLSL/Envobject.*".

==How Overgrowth currently hande Shaders==

Right now
The engine automatically substitutes certain shader strings with a different/expanded string with extra options in place.

This means, even if seems to be that an object is using one of the shaders set inside Data/GLSL, the truth is that the engine is replacing it with another path making a reference to the shader created on envobject.
For example:

"cubemap" -> "envobject #TANGENT"

"cubemapobj" or "cubemapobjchar" or "cubemapobjitem" -> "envobject"

"cubemapalpha" -> "envobject #TANGENT #ALPHA"

"plant" or "plant_less_movement" -> "envobject #TANGENT #ALPHA #PLANT"

"plant_foliage" -> "envobject #TANGENT #ALPHA #PLANT #NO_DECALS"

"detailmap4" -> "envobject #DETAILMAP4 #TANGENT"

"detailmap4tangent" -> "envobject #DETAILMAP4 #TANGENT #BASE_TANGENT"

"MagmaFloor" -> "envobject #MAGMA_FLOOR"

"MagmaFlow" -> "envobject #MAGMA_FLOW"

==Creation of your custom shader==

To create or modify an existing shader:

# Copy the Envobject.* files and paste them on Data/GLSL folder inside your mod.
# Rename the envobject files to another name so it wont conflict with those from the game (we will use EnvobjectEx.* on this guide).
# Set the name of your shader. On this case our name will be <code>CUSTOM_SHADER</code>
# Write somewhere on the file your shader code by setting it inside an "if" statement.
For example: <code>#ifdef CUSTOM_SHADER</code>
and then close it with <code>#endif</code>
# Now, you can easily put your shader to work on any object very easily. Just go to your object .XML file, and inside the ShaderName tags, set something like this
<ShaderName>EnvobjectEx #CUSTOM_SHADER</ShaderName>
And now your shader will work.

Shader Creation

2018-01-26T19:11:56Z

Edoantonioco: Created page with "Category: Modding Category: Overgrowth ==How a shader works== Usually, shaders are compund of 2 files: the .frag and the .vert. But most of the time, the relevant infor..."

[[Category: Modding]]
[[Category: Overgrowth]]

==How a shader works==

Usually, shaders are compund of 2 files: the .frag and the .vert. But most of the time, the relevant information is set on the .frag file.

Overgrowth doesnt support this approach anymore, all the existing shaders on Overgrowth are stored on "Data/GLSL/Envobject.*".

==How Overgrowth currently hande Shaders==

Right now
The engine automatically substitutes certain shader strings with a different/expanded string with extra options in place.

This means, even if seems to be that an object is using one of the shaders set inside Data/GLSL, the truth is that the engine is replacing it with another path making a reference to the shader created on envobject.
For example:

"cubemap" -> "envobject #TANGENT"

"cubemapobj" or "cubemapobjchar" or "cubemapobjitem" -> "envobject"

"cubemapalpha" -> "envobject #TANGENT #ALPHA"

"plant" or "plant_less_movement" -> "envobject #TANGENT #ALPHA #PLANT"

"plant_foliage" -> "envobject #TANGENT #ALPHA #PLANT #NO_DECALS"

"detailmap4" -> "envobject #DETAILMAP4 #TANGENT"

"detailmap4tangent" -> "envobject #DETAILMAP4 #TANGENT #BASE_TANGENT"

"MagmaFloor" -> "envobject #MAGMA_FLOOR"

"MagmaFlow" -> "envobject #MAGMA_FLOW"

==Creation of your custom shader==

To create or modify an existing shader:

# Copy the Envobject.* files and paste them on Data/GLSL folder inside your mod.
# Rename the envobject files to another name so it wont conflict with those from the game (we will use EnvobjectEx.* on this guide).
# Set the name of your shader. On this case our name will be <code>CUSTOM_SHADER</code>
# Write somewhere on the file your shader code by setting it inside an "if" statement.
For example: <code>#ifdef CUSTOM_SHADER</code>
and then close it with <code>#endif</code>
# Now, you can easily put your shader to work on any object very easily. Just go to your object .XML file, and inside the ShaderName tags, set something like this
<ShaderName>EnvobjectEx #CUSTOM_SHADER</ShaderName>
And now your shader will work.