Difference between revisions of "Hotspots"

From Wolfire Games Wiki
Jump to: navigation, search
(More WIP)
(More WIP on adding hotspots)
Line 150: Line 150:
  
 
=== general_campaign_level ===
 
=== general_campaign_level ===
−
 
+
'''TODO:''' How does this work?
−
==== Script Params ====
 
−
 
 
  
 
=== generic_kill ===
 
=== generic_kill ===
 +
Kills any character that enters the hotspot.
  
 
==== Script Params ====
 
==== Script Params ====
−
 
+
{| class="wikitable"
−
 
+
|-
−
=== kill ===
+
! Parameter !! Type !! Description
−
 
+
|-
−
==== Script Params ====
+
! KillNPC
−
 
+
| bool || If checked, the hotspot is lethal to NPCs
 +
|-
 +
! KillPlayer
 +
| bool || If checked, the hotspot is lethal to the player
 +
|}
  
 
=== lava_kill ===
 
=== lava_kill ===
−
 
+
Ignites and instantly kills any character that comes into contact with the hotspot.
−
==== Script Params ====
 
−
 
 
  
 
=== levelwin ===
 
=== levelwin ===
 +
Sends a global "levelwin" message when the player enters the hotspot.
  
 
==== Script Params ====
 
==== Script Params ====
−
 
+
{| class="wikitable"
 +
|-
 +
! Parameter !! Type !! Description
 +
|-
 +
! branch
 +
| string || After the "levelwin" message, a space is added and then this string
 +
|}
  
 
=== loadlevel ===
 
=== loadlevel ===
 +
Loads a specified level when the player enters the hotspot.
  
 
==== Script Params ====
 
==== 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 ===
 
=== lugaru_hawk ===
−
 
+
Adds a hawk that circles around the hotspot.
−
==== Script Params ====
 
−
 
 
−
 
 
−
=== lugaru_level ===
 
−
 
 
−
==== Script Params ====
 
−
 
 
−
 
 
−
=== must_visit_trigger ===
 
−
 
 
−
==== Script Params ====
 
−
 
 
  
 
=== new_checkpoint ===
 
=== 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 ====
 
==== 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 ===
 
=== no_grab ===
 +
Any ledge within this hotspot can't be grabbed. You would usually use the collision painting system to decide whether a ledge is grabbable, but if you want to for instance make a ledge in a prefab not grabbable you can't always do that, so you can then use this no_grab hotspot instead.
  
−
==== Script Params ====
+
=== 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.
  
−
=== object_disappear ===
+
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 ====
 
==== 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 ===
 
=== overgrowth_level ===
 +
The hotspot used in the Overgrowth story.
  
−
==== Script Params ====
+
'''TODO:''' Should another hotspot be used instead of this one?
−
 
 
  
 
=== overgrowth_level_checkpoint ===
 
=== overgrowth_level_checkpoint ===
 +
The checkpoints used in the Overgrowth story.
  
−
==== Script Params ====
+
'''TODO:''' Should another hotspot be used instead of this one?
  
 +
=== portal ===
 +
Allows for traveling bwtween levels. Requires a [[#portal_manager|portal_manager]] hotspot to function properly.
  
−
=== particle_foggy ===
+
You can specify a light that gets brighter as a character approaches the portal.
−
 
 
−
==== Script Params ====
 
−
 
 
  
−
=== portal ===
+
To be able to travel to this portal from another level you need to create a ''Load → Utility → Player Spawn'' object.
  
 
==== Script Params ====
 
==== 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 ===
 
=== portal_manager ===
 +
Required when using the portal hotspot.
  
 
==== Script Params ====
 
==== Script Params ====
−
 
+
{| class="wikitable"
 +
|-
 +
! Parameter !! Type !! Description
 +
|-
 +
! Level to load
 +
| int list || The IDs of all portals in the level
 +
|}
  
 
=== resetcharacter ===
 
=== resetcharacter ===
−
 
+
Resets any character that touches this hotspot to their spawn location.
−
==== Script Params ====
 
−
 
 
  
 
=== resetlevel ===
 
=== resetlevel ===
−
 
+
Resets the level when the player touches it, as if you press L in the editor.
−
==== Script Params ====
 
−
 
 
  
 
=== respawn_at_checkpoint ===
 
=== 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]].
−
==== Script Params ====
 
−
 
 
  
 
=== soak_level ===
 
=== soak_level ===
Line 303: Line 335:
 
==== Script Params ====
 
==== Script Params ====
  
−
== Useless Hotspots ==
+
== 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, can't be used on their own, or are simply old and forgotten.
 
These hotspots have either been replaced by a better alternative, have stopped working at some point during the development of the game, can't be used on their own, or are simply old and forgotten.
  
 
=== announce_items ===
 
=== announce_items ===
−
Remnant from old tutorial
+
Remnant from old tutorial level.
−
 
 
−
'''TODO:''' Link to article showing how to use snow shader.
 
  
 
=== Checkpoint ===
 
=== Checkpoint ===
Line 333: Line 363:
 
=== fixedragdollpart ===
 
=== fixedragdollpart ===
 
Not used on its own, used in aschar for impaling.
 
Not used on its own, used in aschar for impaling.
 +
 +
=== kill ===
 +
Deprecated, use the generic_kill or 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 ===
 
=== rain ===
Line 341: Line 383:
 
=== snow ===
 
=== snow ===
 
Particle based snow, use the snow shaders instead.
 
Particle based snow, use the snow shaders instead.
 +
 +
'''TODO:''' Link to article showing how to use snow shader.

Revision as of 15:17, 2 March 2018

TODO: This entire page is a work in progress, gotta finish it!

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. If you're looking for how to create your own hotspots, see the Hotspot Scripting page.

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

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

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

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

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

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

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

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

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

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

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 hotspot. Entering this hotspot makes this the current checkpoint. When touching a respawn_at_checkpoint you get teleported to the center of the most recently touched new_checkpoint hotspot.

Script Params

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 hotspot

no_grab

Any ledge within this hotspot can't be grabbed. You would usually use the collision painting system to decide whether a ledge is grabbable, but if you want to for instance make a ledge in a 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

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.

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

overgrowth_level_checkpoint

The checkpoints used in the Overgrowth story.

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

portal

Allows for traveling bwtween levels. Requires a 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

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

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 hotspot. When the player touches this hotspot they get teleported to the center of the most recently touched new_checkpoint.

soak_level

Script Params

spike

Script Params

spike_tip

Script Params

start_dialogue

Script Params

StartRace

Script Params

tutorial

Script Params

victorytrigger

Script Params

water

Script Params

water_bob

Script Params

water_bob_fast

Script Params

wet_cube

Script Params

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, can't be used on their own, or are simply old and forgotten.

announce_items

Remnant from old tutorial level.

Checkpoint

No longer used, should use the new checkpoint system instead.

TODO: use what instead specifically?

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.

fixedragdollpart

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

kill

Deprecated, use the generic_kill or 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 rain shaders instead.

TODO: Link to article showing how to use rain shader.

snow

Particle based snow, use the snow shaders instead.

TODO: Link to article showing how to use snow shader.

Retrieved from "https://wiki.wolfire.com/index.php?title=Hotspots&oldid=5659"