Wolfire Games Wiki - User contributions [en]

File:N-Tab-anim-controls.PNG

2018-07-20T13:34:12Z

Mng: Mng uploaded a new version of File:N-Tab-anim-controls.PNG

File:N-Tab-anim-controls.PNG

2018-07-20T13:29:27Z

Mng: Mng uploaded a new version of File:N-Tab-anim-controls.PNG

File:N-Tab-anim-controls.PNG

2018-07-20T13:20:43Z

Mng:

Custom Animations

2018-07-20T13:15:53Z

Mng: /* Event Keyframes */ Removed almost definitely redundant table columns. Removed TODOs. Added more events to table.

==Overview==
Animations for rigged objects in Overgrowth are stored with one of the Phoenix Engine's custom [[Binary_File_Formats|binary file formats]], namely the [[Binary_File_Formats#PHXANM|PHXANM (Phoenix Animation) format]]. To export an animation to a PHXANM (File mask: .anm) file you need to use Wolfire's custom export addon for Blender. A repackaged version of Blender for Windows with the export addon and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here].

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* Click the '''From Timeline''' button to set the timeline's start & end frames as the start & end points of your animation; '''Note:''' Keyframes outside of this time frame won't be exported.
#* Set the '''Looping''' value to 0 if you don't want your animation to loop. Set it to 1 if you want it to loop. '''Todo: If the value is higher, will it do sth different, like play the animation n times?'''
# With the skeleton selected('''TODO: Is that important?'''), press '''File > Export > Phoenix Animation (.anm)'''

==Event Keyframes==
Event keyframes are used to tell the game at which moment of an animation an event is going to happen. This is used to trigger attack impacts and footstep sounds among other things.
An event is saved as a ''Custom Property'' of a bone in the Blender files shipped with the game.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate bone for the event you want to trigger while being in pose mode
# Set the playhead in the timeline to the moment you want the event to happen
# In the '''Properties''' editor, press '''Bone''' and scroll down to '''Custom Properties'''
# Hover over the property that corresponds to the event you want to trigger and press '''I''' to add a keyframe. (Value doesn't matter)

==Animating Morph Targets==
'''Todo: Add this section'''
[[Category: Overgrowth]]
[[Category: Modding]]

Dialogue Editor

2018-06-16T08:07:38Z

Mng: /* Depth of Field */ Added Note.

'''TODO: Figure out how to best cover all the missing send_level_message and send_character_message commands.'''

This is the technical documentation for the dialogue editor. It's used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

Before reading this article it's recommended that you read the [[Dialogue]] article to get a basic understanding of how dialogues work.

== General Dialogue Functions ==

=== Set Dialogue Name ===
Command: <code>#name "$"</code>

Example: <code>#name "chat_with_villager"</code>

Sets the name of the current dialogue to whatever is written in <code>$</code>. This can be used by some other hotspots to start the dialogue.

=== Set Number of Participants ===
Command: <code>#participants $</code>

Example: <code>#participants 3</code>

Sets the number of participants in the dialogue to the number written in <code>$</code>.

=== Dialogue ===
Command: <code>say # "n" "m"</code>

Example: <code>say 1 "Turner" "Hello, I am participant 1 in the dialogue and my name is Turner."</code>

Makes participant <code>#</code> say <code>m</code> while the name tag shows <code>n</code>.

=== Waiting ===
Command: <code>[wait $]</code>

Example: <code>say 1 "Turner" "Hmm... [wait 0.5]I should eat some carrots!"</code>

Put somewhere in the middle of a say command to pause the text printing for <code>$</code> seconds.

=== Wait For Click ===
Command: <code>[wait_for_click]</code>

Example: <code>say 1 "Turner" "But why!? [wait_for_click]Why did you burn all the lettuce!?"</code>

Put somewhere in the middle of a say command to pause the text printing until the player left clicks.

=== Name Tag Color ===
Command: <code>set_dialogue_color # r g b</code>

Example: <code>set_dialogue_color 2 0.8 0 0.8</code>

When participant <code>#</code> says something, their name tag will have the color specified by the float values in <code>r, g, b</code> (red, green, blue).

=== Voice ===
Command: <code>set_dialogue_voice # i</code>

Example: <code>set_dialogue_voice 2 8</code>

Sets the voice of participant <code>#</code> to <code>i</code>.

In the menu bar of the dialogue editor, go to ''Edit → Preview Voice'' and click and drag through the slider to hear previews of all the different voices.

=== Camera Position ===
Command: <code>set_cam tx ty tz rx ry rz</code>

Example: <code>set_cam 5.0 3.1 2.5 0.0 0.0 0.0</code>

Sets the location of the camera for the next <code>say</code> command to <code>tx, ty, tz</code> (translation x, y, z), and sets the rotation to <code>rx, ry, rz</code> (rotation x, y, z).

You don't need to set this manually in the script because this line will be generated automatically when you move the camera object that is located on the dialogue hotspot by default when editing a dialogue. Keep in mind that when you do this you need to first select the <code>say</code> command in the script that you want to change the camera angle for, as the <code>set_cam</code> line will be put before that line.

However, in some cases it can be very useful to be able to copy a <code>set_cam</code> line from one place to another and things like that.

=== Character Position ===
Command: <code>set_character_pos # x y z r</code>

Example: <code>set_character_pos 1 3.0 0.0 5.0 30</code>

Sets the location of participant <code>#</code> to <code>x, y, z</code>, and rotates them around the vertical axis <code>r</code> degrees.

Just like with [[#Camera_Position|camera positions]] you don't need to manually set character positions in the script since the appropriate line of code will be automatically generated when you move one of the character position boxes that can be found by default on each participant's spawn box. As with camera positions, you need to make sure to select the <code>say</code> line that you want to edit before making any changes.

Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.

=== Pose ===
Command: <code>send_character_message # "set_animation \"$\""</code>

Example: <code>send_character_message 1 "set_animation \"Data/Animations/r_dialogue_shade.anm\""</code>

Makes participant <code>#</code> play the animation at <code>$</code>. Note that we're using ''\"'' to "escape" the <code>"</code> characters.

You don't have to write this line manually because it can be generated for you if you do the following:

# Click on the <code>say</code> line in the dialogue that you want the animation to play for
# Select the dialogue character position box in the 3D view for the character you want to play an animation
# In the dialogue editor's menu bar, press ''File → Load Pose'' and load the animation you want

All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.

=== Eye, Head & Torso Movement ===
Command: <code>send_character_message # "$ x y z i"</code>

Example: <code>send_character_message 2 "set_head_target 5.0 3.2 1.1 0.8"</code>

Makes participant <code>#</code> turn their <code>$</code> towards location <code>x, y, z</code>, with the influence <code>i</code>. If <code>i</code> is <code>1</code>, it will face as much towards <code>x, y, z</code> as possible, and if it's 0 the command has no effect.

<code>$</code> Can be set to <code>set_head_target</code> or <code>set_torso_target</code>. <code>set_eye_dir</code> used to work, but currently dosn't.

This command doesn't need to be written manually, because it will be automatically set for the currently selected <code>say</code> line when you move one of the eye, head or torso targets. Scale the targets to change the influence.

=== Depth of Field ===
Command: <code>send_level_message "set_camera_dof cs cd cg fs fd fg"</code>

Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>

'''NOTE:''' The player character needs to be connected to the dialogue for it to work.

* cs = Close blur strength
* cd = Anything closer than this value will be blurred
* cg = How gradual the transition for close dof should be, 0 = infinite blur
* fs = Far blur strength
* fd = Anything further than this value will be blurred
* fg = How gradual the transition for far dof should be, 0 = infinite blur

The depth of field is split into two parts with three parts in each, the close blur and the far blur. First in each part is how strong the blur should be (<code>xs</code>), then at what distance it should end/start (<code>xd</code>), and then how long the transition from/to the blur should be (<code>cg</code>).

=== Fade to Black ===
Command: <code>fade_to_black $</code>

Example: <code>fade_to_black 1</code>

<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.

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

Wolfire Games Wiki:About

2018-06-09T17:56:33Z

Mng: Added template, but maybe this should just redirect to the front page? Or it could be it's own page, of course.

Custom Animations

2018-04-10T21:46:29Z

Mng: /* Exporting an animation */ added TODO: Is that important?

==Overview==
Animations for rigged objects in Overgrowth are stored with one of the Phoenix Engine's custom [[Binary_File_Formats|binary file formats]], namely the [[Binary_File_Formats#PHXANM|PHXANM (Phoenix Animation) format]]. To export an animation to a PHXANM (File mask: .anm) file you need to use Wolfire's custom export addon for Blender. A repackaged version of Blender for Windows with the export addon and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here].

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* Click the '''From Timeline''' button to set the timeline's start & end frames as the start & end points of your animation; '''Note:''' Keyframes outside of this time frame won't be exported.
#* Set the '''Looping''' value to 0 if you don't want your animation to loop. Set it to 1 if you want it to loop. '''Todo: If the value is higher, will it do sth different, like play the animation n times?'''
# With the skeleton selected('''TODO: Is that important?'''), press '''File > Export > Phoenix Animation (.anm)'''

==Event Keyframes==
Event keyframes are used to tell the game at which moment of an animation an event is going to happen. This is used to trigger attack impacts and footstep sounds among other things.
An event is saved as a ''Custom Property'' of a bone in the Blender files shipped with the game.
'''TODO: Maybe a list with event keyframes could be helpful?
{| class="wikitable"
|-
! Event !! Applyable to !! Value !! Description
|-
| attackimpact || every bone || Doesn't matter ? || Will trigger the actual impact while attacking a character
|-
| rightrunstep || every bone || Doesn't matter ? Sound volume ?|| Will trigger footstepsound, particles and IK ?
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate bone for the event you want to trigger while being in pose mode
# Set the playhead in the timeline to the moment you want the event to happen
# In the '''Properties''' "editor type", ('''TODO: Better name for this? If not, remove''') press '''Bone''' and scroll down to '''Custom Properties'''
# Hover over the property that corresponds to the event you want to trigger and press '''I''' to add a keyframe. (Value doesn't matter '''TODO: is this true for every event keyframe? Or at all?''')

==Animating Morph Targets==
'''Todo: Add this section'''
[[Category: Overgrowth]]
[[Category: Modding]]

Custom Animations

2018-04-10T21:36:52Z

Mng: Added basic layout & text.

==Overview==
Animations for rigged objects in Overgrowth are stored with one of the Phoenix Engine's custom [[Binary_File_Formats|binary file formats]], namely the [[Binary_File_Formats#PHXANM|PHXANM (Phoenix Animation) format]]. To export an animation to a PHXANM (File mask: .anm) file you need to use Wolfire's custom export addon for Blender. A repackaged version of Blender for Windows with the export addon and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here].

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* Click the '''From Timeline''' button to set the timeline's start & end frames as the start & end points of your animation; '''Note:''' Keyframes outside of this time frame won't be exported.
#* Set the '''Looping''' value to 0 if you don't want your animation to loop. Set it to 1 if you want it to loop. '''Todo: If the value is higher, will it do sth different, like play the animation n times?'''
# With the skeleton selected, press '''File > Export > Phoenix Animation (.anm)'''

==Event Keyframes==
Event keyframes are used to tell the game at which moment of an animation an event is going to happen. This is used to trigger attack impacts and footstep sounds among other things.
An event is saved as a ''Custom Property'' of a bone in the Blender files shipped with the game.
'''TODO: Maybe a list with event keyframes could be helpful?
{| class="wikitable"
|-
! Event !! Applyable to !! Value !! Description
|-
| attackimpact || every bone || Doesn't matter ? || Will trigger the actual impact while attacking a character
|-
| rightrunstep || every bone || Doesn't matter ? Sound volume ?|| Will trigger footstepsound, particles and IK ?
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate bone for the event you want to trigger while being in pose mode
# Set the playhead in the timeline to the moment you want the event to happen
# In the '''Properties''' "editor type", ('''TODO: Better name for this? If not, remove''') press '''Bone''' and scroll down to '''Custom Properties'''
# Hover over the property that corresponds to the event you want to trigger and press '''I''' to add a keyframe. (Value doesn't matter '''TODO: is this true for every event keyframe? Or at all?''')

==Animating Morph Targets==
'''Todo: Add this section'''
[[Category: Overgrowth]]
[[Category: Modding]]

Custom Characters

2018-04-10T20:09:18Z

Mng: /* Rigging the Character */ Removed '''TODO: What file is supposed to be used as a base?...; Removed TODO: Is this correct?; Changed Text

{{About||custom character scripts|Character_Scripting}}
'''TODO: Put this link graciously provided by Markuss in its appropriate section:''' 
https://cdn.wolfire.com/techsupport/ExampleMan.zip 

'''TODO: Write introduction'''

== Overview ==

[[Image:custom_character_file_structure.png|right|thumb|caption|All required files and what they contain]]

Characters in overgrowth consist of the following files.

{| class="wikitable"
|-
! Name !! File format !! Description
|-
! Script
| XML || Links the character xml with an AI script
|-
! Character
| XML || Links an object xml with rigging data, animations and attacks
|-
! Object
| XML || A regular object xml file, links to a model and textures
|-
! Rigging data
| XML || Links a model and a skeleton together so the model can be animated
|-
! Textures
| TGA || The textures used by the character
|-
! Model
| OBJ || The 3D mesh used by the character
|-
! Hull
| OBJ || The simplified collision to use for the character
|-
! Skeleton
| PHXBN || The bone structure used by the character for animation
|-
! Ragdoll collision
| FZX || Convex hulls used for ragdoll physics
|}

To create a character for Overgrowth you need to...
# Model and texture the character; [[#Model_and_Texture_Considerations|be sure to get these points right]]
# '''Optional:''' Create a simplified hull model for collision
:::'''Note:''' Thrown weapons won't collide with characters if they don't have a hull-object.
# [[#Rigging_the_Character|Rig the character using one of the included skeletons and export it to the '''.phxbn''' format]]
# [[#Object_XML|Create an object XML linking the model and the texture]]
# [[#Rigging_data_XML|Create a rigging data XML linking the model and the skeleton]]
# [[#Character_XML|Create a character XML linking the rigging data XML and the object XML with a set of attacks and animations the character should use]]
# [[#Script_XML|Create a script XML linking the character XML with an AI script]]

The final script XML is the file that's actually loaded in the game to create the character. This article goes through all the above steps.

== Model and Texture Considerations ==
[[Image:ExampleMan_mesh.jpg|thumb|Character Model Faces Z-axis and has reset ]]
The model and textures for the character have the same requirements as when creating any other [[3D Objects|3D Object]], but with a few extra considerations.

It's extra important for characters that the model is centered to the middle of the scene, standing on the grid floor with location and rotation set to zero, and scale set to one. It should loosely match the pose and proportions of the Overgrowth characters, you can use the following file for pose and size reference: ''../Overgrowth/Data/Models/Characters/Rabbit/rabbit.obj''.

There is no character shader that supports tangent space normal maps. If you want to use a tangent space normal map anyway, the cubemap shader can be used. Though doing so will make the object look a bit different in the engine. More information about these shaders can be found in the [[3D_Objects#Shaders|3D Objects]] article.

[[Image:ExampleMan_Norm.jpg|thumb|This is what a Blank/Flat object-space normal map might look like]]

=== Fur Fins ===
'''TODO:''' Write about how fur fins work

== Rigging the Character ==
Overgrowth uses one of the custom [[Binary_File_Formats|binary file formats]], namely the [[Binary_File_Formats#PHXBN|PHXBN (Phoenix Bones) format]] to store skeletons. To export a skeleton to a PHXBN file you need to use Wolfire's custom export addon for Blender. A repackaged version of Blender for Windows with the export addons and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here]. You may need to restart the program once to get the export options to show up.

'''TODO: How do you set this up yourself, if you're not using Windows for instance?'''

This article won't teach you how to use Blender, it only gives the information essential to get a character into the game. If you need to learn the basics of Blender, [https://cgcookie.com CG Cookie] has a good free video tutorial series that introduces you to the software.

Here are the steps you need to take in Blender to create the PHXBN file:

# Open '''Data\BlendFiles\rabbit_rig.blend''' in Blender 2.55 with the PHXBN-add-on installed
:::'''Note:''' If you download Blender from the link provided at the top of this page, the right file is already loaded.
# Replace the white/pink rabbit
#* Press '''File > Import > Wavefront (.obj)''' to import an obj file.
# Bind your own mesh to the skeleton
#* First select the mesh, then shift-select the skeleton to add it to your selection before you press Ctrl + P and select '''Armature Deform → With Empty Groups/With Envelope Weights/With Automatic Weights''' depending on what you want to bind them.
# Paint weights if you need to, or use the automatic weights
#* You may want to look up a tutorial on painting weights in blender.
#* It is recommended that you test your character in engine with automatic weights to check that you have no errors before you start working on a final weight paint. It won’t look pretty, but will let you know early on if the character is going to work in the engine.
# Export your files
#* With skeleton selected in object mode, export as .PHXBN, same for mesh but as .OBJ. Your model needs to be in rest position when doing this.

== Object XML ==
This is a regular object file as described in the [[3D_Objects#Basics | 3D reference guide]]. Note that the ShaderName flags (like #TANGENT for instance) don't make any difference for characters since they use a pre-detemined path through the uber shader.
<pre>
<?xml version="1.0"?>
<Object>
<Model>Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj</Model>
<ColorMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Color.TGA</ColorMap>
<NormalMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Norm.TGA</NormalMap>
<ShaderName>envobject</ShaderName>
</Object>
</pre>

== Rigging data XML ==
Links to the .OBJ and .PHXBN files that the engine needs to rig the character.
<pre>
<?xml version="1.0" ?>
<rig bone_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.phxbn"
model_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj"/>
</pre>

== Character XML ==
Links to the object XML and rigging data XML files as well as the animations and attacks the character will use.
<pre>
<?xml version="1.0" ?>
<character>
<appearance obj_path = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_Object.xml"
skeleton = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_RigFiles.xml"/>
<animations idle = "Data/Animations/r_idle2.xml"
jump = "Data/Animations/r_jump.xml"
roll = "Data/Animations/r_roll.xml"
movement = "Data/Animations/r_movement.xml"
wall = "Data/Animations/r_wall.xml"
ledge = "Data/Animations/r_ledge.anm"
medrightblock = "Data/Animations/r_activeblockmedright.anm"
medleftblock = "Data/Animations/r_activeblockmedleft.anm"
highrightblock = "Data/Animations/r_activeblockhighright.anm"
highleftblock = "Data/Animations/r_activeblockhighleft.anm"
lowrightblock = "Data/Animations/r_activeblocklowright.anm"
lowleftblock = "Data/Animations/r_activeblocklowleft.anm"
blockflinch = "Data/Animations/r_activeblockflinch.anm"/>
<attacks moving_close = "Data/Attacks/haymaker.xml"
stationary_close = "Data/Attacks/thrustpunch.xml"
moving = "Data/Attacks/spinkick.xml"
stationary = "Data/Attacks/frontkick.xml"
moving_low = "Data/Attacks/soccerkick.xml"
low = "Data/Attacks/sweep.xml"
air = "Data/Attacks/legcannon.xml" />
</character>
</pre>

== Script XML ==
Links to the character XML file and an AI script, this is the file you choose when loading a character.
<pre>
<?xml version="1.0" ?>
<Actor>
<Character>Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_AnimList.xml</Character>
<ControlScript>enemycontrol.as</ControlScript>
</Actor>
</pre>

== Adding Characters to the spawner menu ==

Short version:
* You must add it in a mod.
* You can add as many characters to the spawner menu as you want in a single mod, you just need to follow the below instructions for each, and add multiple <code><Item></code> tags to your mod.xml file.

In your mod.xml file, add this xml tag:
('''TODO''': Make these paths more specific to characters)

<pre><Item category="My Custom Mod Characters"
title="Some Character To Spawn"
path="Data/Objects/example_item_pack/mod_item_example.xml"
thumbnail="Data/UI/example_item_pack/thumbs/mod_item_example.png" /></pre>

* '''<code>category</code>''' is the top level category where the character will show up, in the '''Load''' menu.
* '''<code>title</code>''' is the name of the character, as it will show up in the spawner menu.
* '''<code>path</code>''' is the path to the character XML that will get spawned. See [[#How_to_create_a_character|the '''How to create a character''' section]] for which XML file to target (either the character XML itself, or a version you saved off that has modified default parameters). '''TODO''': Be careful to advise ''which'' character XML to add to the spawner - there are multiple character XML files!
* '''<code>thumbnail</code>''' is the image that will be used for a tooltip when you hover over your character in the spawner menu.

See '''<code>GameInstallDir/Data/ExampleMods/mod_xml_specification.txt</code>''' for full information.

== TODOs ==
'''TODO: Make sure all these headings are covered in this or some other article that we link to'''

=== File path conventions ===

'''TODO''': Description of where to add files in mods so they don't conflict. Ala [[Hotspots#File_path_conventions]]

=== Hull ===

'''TODO''': Links to or docs on character hulls

=== Animations ===

'''TODO''': Links to or docs on animations and export, tagging, etc

=== Morph targets ===

'''TODO''': Links to or docs on morph target animations for hands, face, etc

=== Eyes ===

'''TODO''': Links to or docs on morph target animations for eyes (might roll this up into other sections/other pages?)

=== Attacks ===

'''TODO''': Links to or docs on attacks system and export, tagging, etc - related partly to animations. 

'''TODO''': Possibly also scripting attacks and animations, and character-bound input, etc - though maybe that should be in a different section?

Custom Characters

2018-04-10T19:43:35Z

Mng: /* Overview */ Removed '''TODO: Link all the below steps to parts of this page'''; removed '''TODO: What do you need to export? The skeleton? Only the weight painted mesh?'''

{{About||custom character scripts|Character_Scripting}}
'''TODO: Put this link graciously provided by Markuss in its appropriate section:''' 
https://cdn.wolfire.com/techsupport/ExampleMan.zip 

'''TODO: Write introduction'''

== Overview ==

[[Image:custom_character_file_structure.png|right|thumb|caption|All required files and what they contain]]

Characters in overgrowth consist of the following files.

{| class="wikitable"
|-
! Name !! File format !! Description
|-
! Script
| XML || Links the character xml with an AI script
|-
! Character
| XML || Links an object xml with rigging data, animations and attacks
|-
! Object
| XML || A regular object xml file, links to a model and textures
|-
! Rigging data
| XML || Links a model and a skeleton together so the model can be animated
|-
! Textures
| TGA || The textures used by the character
|-
! Model
| OBJ || The 3D mesh used by the character
|-
! Hull
| OBJ || The simplified collision to use for the character
|-
! Skeleton
| PHXBN || The bone structure used by the character for animation
|-
! Ragdoll collision
| FZX || Convex hulls used for ragdoll physics
|}

To create a character for Overgrowth you need to...
# Model and texture the character; [[#Model_and_Texture_Considerations|be sure to get these points right]]
# '''Optional:''' Create a simplified hull model for collision
:::'''Note:''' Thrown weapons won't collide with characters if they don't have a hull-object.
# [[#Rigging_the_Character|Rig the character using one of the included skeletons and export it to the '''.phxbn''' format]]
# [[#Object_XML|Create an object XML linking the model and the texture]]
# [[#Rigging_data_XML|Create a rigging data XML linking the model and the skeleton]]
# [[#Character_XML|Create a character XML linking the rigging data XML and the object XML with a set of attacks and animations the character should use]]
# [[#Script_XML|Create a script XML linking the character XML with an AI script]]

The final script XML is the file that's actually loaded in the game to create the character. This article goes through all the above steps.

== Model and Texture Considerations ==
[[Image:ExampleMan_mesh.jpg|thumb|Character Model Faces Z-axis and has reset ]]
The model and textures for the character have the same requirements as when creating any other [[3D Objects|3D Object]], but with a few extra considerations.

It's extra important for characters that the model is centered to the middle of the scene, standing on the grid floor with location and rotation set to zero, and scale set to one. It should loosely match the pose and proportions of the Overgrowth characters, you can use the following file for pose and size reference: ''../Overgrowth/Data/Models/Characters/Rabbit/rabbit.obj''.

There is no character shader that supports tangent space normal maps. If you want to use a tangent space normal map anyway, the cubemap shader can be used. Though doing so will make the object look a bit different in the engine. More information about these shaders can be found in the [[3D_Objects#Shaders|3D Objects]] article.

[[Image:ExampleMan_Norm.jpg|thumb|This is what a Blank/Flat object-space normal map might look like]]

=== Fur Fins ===
'''TODO:''' Write about how fur fins work

== Rigging the Character ==
Overgrowth uses a custom skeleton format for characters with the PHXBN (Phoenix Bone '''TODO: Is this correct?''') file ending. To create this file you need to use Wolfire's custom export addons for Blender. A repackaged version of Blender for Windows with the export addons and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here]. You may need to restart the program once to get the export options to show up.

'''TODO: How do you set this up yourself, if you're not using Windows for instance?'''

This article won't teach you how to use Blender, it only gives the information essential to get a character into the game. If you need to learn the basics of Blender, [https://cgcookie.com CG Cookie] has a good free video tutorial series that introduces you to the software.

Here are the steps you need to take in Blender to create the PHXBN file:

# '''TODO: What file is supposed to be used as a base? It's probably already loaded by default in the custom Blender version that can be downloaded above, but what file is that actually? So people can set this up on their own if they want.'''
# Replace the white rabbit
#* Press '''File > Import > Wavefront (.obj)''' to import an obj file.
# Bind your own mesh to the skeleton
#* First select the mesh, then shift-select the skeleton to add it to your selection before you press Ctrl + P and select '''Armature Deform → With Empty Groups/With Envelope Weights/With Automatic Weights''' depending on what you want to bind them.
# Paint weights if you need to, or use the automatic weights
#* You may want to look up a tutorial on painting weights in blender.
#* It is recommended that you test your character in engine with automatic weights to check that you have no errors before you start working on a final weight paint. It won’t look pretty, but will let you know early on if the character is going to work in the engine.
# Export your files
#* With skeleton selected in object mode, export as .PHXBN, same for mesh but as .OBJ. Your model needs to be in rest position when doing this.

== Object XML ==
This is a regular object file as described in the [[3D_Objects#Basics | 3D reference guide]]. Note that the ShaderName flags (like #TANGENT for instance) don't make any difference for characters since they use a pre-detemined path through the uber shader.
<pre>
<?xml version="1.0"?>
<Object>
<Model>Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj</Model>
<ColorMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Color.TGA</ColorMap>
<NormalMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Norm.TGA</NormalMap>
<ShaderName>envobject</ShaderName>
</Object>
</pre>

== Rigging data XML ==
Links to the .OBJ and .PHXBN files that the engine needs to rig the character.
<pre>
<?xml version="1.0" ?>
<rig bone_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.phxbn"
model_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj"/>
</pre>

== Character XML ==
Links to the object XML and rigging data XML files as well as the animations and attacks the character will use.
<pre>
<?xml version="1.0" ?>
<character>
<appearance obj_path = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_Object.xml"
skeleton = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_RigFiles.xml"/>
<animations idle = "Data/Animations/r_idle2.xml"
jump = "Data/Animations/r_jump.xml"
roll = "Data/Animations/r_roll.xml"
movement = "Data/Animations/r_movement.xml"
wall = "Data/Animations/r_wall.xml"
ledge = "Data/Animations/r_ledge.anm"
medrightblock = "Data/Animations/r_activeblockmedright.anm"
medleftblock = "Data/Animations/r_activeblockmedleft.anm"
highrightblock = "Data/Animations/r_activeblockhighright.anm"
highleftblock = "Data/Animations/r_activeblockhighleft.anm"
lowrightblock = "Data/Animations/r_activeblocklowright.anm"
lowleftblock = "Data/Animations/r_activeblocklowleft.anm"
blockflinch = "Data/Animations/r_activeblockflinch.anm"/>
<attacks moving_close = "Data/Attacks/haymaker.xml"
stationary_close = "Data/Attacks/thrustpunch.xml"
moving = "Data/Attacks/spinkick.xml"
stationary = "Data/Attacks/frontkick.xml"
moving_low = "Data/Attacks/soccerkick.xml"
low = "Data/Attacks/sweep.xml"
air = "Data/Attacks/legcannon.xml" />
</character>
</pre>

== Script XML ==
Links to the character XML file and an AI script, this is the file you choose when loading a character.
<pre>
<?xml version="1.0" ?>
<Actor>
<Character>Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_AnimList.xml</Character>
<ControlScript>enemycontrol.as</ControlScript>
</Actor>
</pre>

== Adding Characters to the spawner menu ==

Short version:
* You must add it in a mod.
* You can add as many characters to the spawner menu as you want in a single mod, you just need to follow the below instructions for each, and add multiple <code><Item></code> tags to your mod.xml file.

In your mod.xml file, add this xml tag:
('''TODO''': Make these paths more specific to characters)

<pre><Item category="My Custom Mod Characters"
title="Some Character To Spawn"
path="Data/Objects/example_item_pack/mod_item_example.xml"
thumbnail="Data/UI/example_item_pack/thumbs/mod_item_example.png" /></pre>

* '''<code>category</code>''' is the top level category where the character will show up, in the '''Load''' menu.
* '''<code>title</code>''' is the name of the character, as it will show up in the spawner menu.
* '''<code>path</code>''' is the path to the character XML that will get spawned. See [[#How_to_create_a_character|the '''How to create a character''' section]] for which XML file to target (either the character XML itself, or a version you saved off that has modified default parameters). '''TODO''': Be careful to advise ''which'' character XML to add to the spawner - there are multiple character XML files!
* '''<code>thumbnail</code>''' is the image that will be used for a tooltip when you hover over your character in the spawner menu.

See '''<code>GameInstallDir/Data/ExampleMods/mod_xml_specification.txt</code>''' for full information.

== TODOs ==
'''TODO: Make sure all these headings are covered in this or some other article that we link to'''

=== File path conventions ===

'''TODO''': Description of where to add files in mods so they don't conflict. Ala [[Hotspots#File_path_conventions]]

=== Hull ===

'''TODO''': Links to or docs on character hulls

=== Animations ===

'''TODO''': Links to or docs on animations and export, tagging, etc

=== Morph targets ===

'''TODO''': Links to or docs on morph target animations for hands, face, etc

=== Eyes ===

'''TODO''': Links to or docs on morph target animations for eyes (might roll this up into other sections/other pages?)

=== Attacks ===

'''TODO''': Links to or docs on attacks system and export, tagging, etc - related partly to animations. 

'''TODO''': Possibly also scripting attacks and animations, and character-bound input, etc - though maybe that should be in a different section?

Custom Characters

2018-04-10T19:25:10Z

Mng: /*Top*/ Added hatnote.

{{About||custom character scripts|Character_Scripting}}
'''TODO: Put this link graciously provided by Markuss in its appropriate section:''' 
https://cdn.wolfire.com/techsupport/ExampleMan.zip 

'''TODO: Write introduction'''

== Overview ==

[[Image:custom_character_file_structure.png|right|thumb|caption|All required files and what they contain]]

Characters in overgrowth consist of the following files.

{| class="wikitable"
|-
! Name !! File format !! Description
|-
! Script
| XML || Links the character xml with an AI script
|-
! Character
| XML || Links an object xml with rigging data, animations and attacks
|-
! Object
| XML || A regular object xml file, links to a model and textures
|-
! Rigging data
| XML || Links a model and a skeleton together so the model can be animated
|-
! Textures
| TGA || The textures used by the character
|-
! Model
| OBJ || The 3D mesh used by the character
|-
! Hull
| OBJ || The simplified collision to use for the character
|-
! Skeleton
| PHXBN || The bone structure used by the character for animation
|-
! Ragdoll collision
| FZX || Convex hulls used for ragdoll physics
|}

'''TODO: Link all the below steps to parts of this page'''

To create a character for Overgrowth you need to..
# Model and texture the character
# '''Optional:''' Create a simplified hull model for collision.
:::'''Note:''' Thrown weapons won't collide with characters if they don't have a hull-object.
# Rig the character using one of the included skeletons
# '''TODO: What do you need to export? The skeleton? Only the weight painted mesh?'''
# Create an object XML linking the model and the texture
# Create a rigging data XML linking the model and the skeleton
# Create a character XML linking the rigging data XML and the object XML with a set of attacks and animations the character should use
# Create a script XML linking the character XML with an AI script

The final script XML is the file that's actually loaded in the game to create the character. This article goes through all the above steps.

== Model and Texture Considerations ==
[[Image:ExampleMan_mesh.jpg|thumb|Character Model Faces Z-axis and has reset ]]
The model and textures for the character have the same requirements as when creating any other [[3D Objects|3D Object]], but with a few extra considerations.

It's extra important for characters that the model is centered to the middle of the scene, standing on the grid floor with location and rotation set to zero, and scale set to one. It should loosely match the pose and proportions of the Overgrowth characters, you can use the following file for pose and size reference: ''../Overgrowth/Data/Models/Characters/Rabbit/rabbit.obj''.

There is no character shader that supports tangent space normal maps. If you want to use a tangent space normal map anyway, the cubemap shader can be used. Though doing so will make the object look a bit different in the engine. More information about these shaders can be found in the [[3D_Objects#Shaders|3D Objects]] article.

[[Image:ExampleMan_Norm.jpg|thumb|This is what a Blank/Flat object-space normal map might look like]]

=== Fur Fins ===
'''TODO:''' Write about how fur fins work

== Rigging the Character ==
Overgrowth uses a custom skeleton format for characters with the PHXBN (Phoenix Bone '''TODO: Is this correct?''') file ending. To create this file you need to use Wolfire's custom export addons for Blender. A repackaged version of Blender for Windows with the export addons and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here]. You may need to restart the program once to get the export options to show up.

'''TODO: How do you set this up yourself, if you're not using Windows for instance?'''

This article won't teach you how to use Blender, it only gives the information essential to get a character into the game. If you need to learn the basics of Blender, [https://cgcookie.com CG Cookie] has a good free video tutorial series that introduces you to the software.

Here are the steps you need to take in Blender to create the PHXBN file:

# '''TODO: What file is supposed to be used as a base? It's probably already loaded by default in the custom Blender version that can be downloaded above, but what file is that actually? So people can set this up on their own if they want.'''
# Replace the white rabbit
#* Press '''File > Import > Wavefront (.obj)''' to import an obj file.
# Bind your own mesh to the skeleton
#* First select the mesh, then shift-select the skeleton to add it to your selection before you press Ctrl + P and select '''Armature Deform → With Empty Groups/With Envelope Weights/With Automatic Weights''' depending on what you want to bind them.
# Paint weights if you need to, or use the automatic weights
#* You may want to look up a tutorial on painting weights in blender.
#* It is recommended that you test your character in engine with automatic weights to check that you have no errors before you start working on a final weight paint. It won’t look pretty, but will let you know early on if the character is going to work in the engine.
# Export your files
#* With skeleton selected in object mode, export as .PHXBN, same for mesh but as .OBJ. Your model needs to be in rest position when doing this.

== Object XML ==
This is a regular object file as described in the [[3D_Objects#Basics | 3D reference guide]]. Note that the ShaderName flags (like #TANGENT for instance) don't make any difference for characters since they use a pre-detemined path through the uber shader.
<pre>
<?xml version="1.0"?>
<Object>
<Model>Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj</Model>
<ColorMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Color.TGA</ColorMap>
<NormalMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Norm.TGA</NormalMap>
<ShaderName>envobject</ShaderName>
</Object>
</pre>

== Rigging data XML ==
Links to the .OBJ and .PHXBN files that the engine needs to rig the character.
<pre>
<?xml version="1.0" ?>
<rig bone_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.phxbn"
model_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj"/>
</pre>

== Character XML ==
Links to the object XML and rigging data XML files as well as the animations and attacks the character will use.
<pre>
<?xml version="1.0" ?>
<character>
<appearance obj_path = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_Object.xml"
skeleton = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_RigFiles.xml"/>
<animations idle = "Data/Animations/r_idle2.xml"
jump = "Data/Animations/r_jump.xml"
roll = "Data/Animations/r_roll.xml"
movement = "Data/Animations/r_movement.xml"
wall = "Data/Animations/r_wall.xml"
ledge = "Data/Animations/r_ledge.anm"
medrightblock = "Data/Animations/r_activeblockmedright.anm"
medleftblock = "Data/Animations/r_activeblockmedleft.anm"
highrightblock = "Data/Animations/r_activeblockhighright.anm"
highleftblock = "Data/Animations/r_activeblockhighleft.anm"
lowrightblock = "Data/Animations/r_activeblocklowright.anm"
lowleftblock = "Data/Animations/r_activeblocklowleft.anm"
blockflinch = "Data/Animations/r_activeblockflinch.anm"/>
<attacks moving_close = "Data/Attacks/haymaker.xml"
stationary_close = "Data/Attacks/thrustpunch.xml"
moving = "Data/Attacks/spinkick.xml"
stationary = "Data/Attacks/frontkick.xml"
moving_low = "Data/Attacks/soccerkick.xml"
low = "Data/Attacks/sweep.xml"
air = "Data/Attacks/legcannon.xml" />
</character>
</pre>

== Script XML ==
Links to the character XML file and an AI script, this is the file you choose when loading a character.
<pre>
<?xml version="1.0" ?>
<Actor>
<Character>Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_AnimList.xml</Character>
<ControlScript>enemycontrol.as</ControlScript>
</Actor>
</pre>

== Adding Characters to the spawner menu ==

Short version:
* You must add it in a mod.
* You can add as many characters to the spawner menu as you want in a single mod, you just need to follow the below instructions for each, and add multiple <code><Item></code> tags to your mod.xml file.

In your mod.xml file, add this xml tag:
('''TODO''': Make these paths more specific to characters)

<pre><Item category="My Custom Mod Characters"
title="Some Character To Spawn"
path="Data/Objects/example_item_pack/mod_item_example.xml"
thumbnail="Data/UI/example_item_pack/thumbs/mod_item_example.png" /></pre>

* '''<code>category</code>''' is the top level category where the character will show up, in the '''Load''' menu.
* '''<code>title</code>''' is the name of the character, as it will show up in the spawner menu.
* '''<code>path</code>''' is the path to the character XML that will get spawned. See [[#How_to_create_a_character|the '''How to create a character''' section]] for which XML file to target (either the character XML itself, or a version you saved off that has modified default parameters). '''TODO''': Be careful to advise ''which'' character XML to add to the spawner - there are multiple character XML files!
* '''<code>thumbnail</code>''' is the image that will be used for a tooltip when you hover over your character in the spawner menu.

See '''<code>GameInstallDir/Data/ExampleMods/mod_xml_specification.txt</code>''' for full information.

== TODOs ==
'''TODO: Make sure all these headings are covered in this or some other article that we link to'''

=== File path conventions ===

'''TODO''': Description of where to add files in mods so they don't conflict. Ala [[Hotspots#File_path_conventions]]

=== Hull ===

'''TODO''': Links to or docs on character hulls

=== Animations ===

'''TODO''': Links to or docs on animations and export, tagging, etc

=== Morph targets ===

'''TODO''': Links to or docs on morph target animations for hands, face, etc

=== Eyes ===

'''TODO''': Links to or docs on morph target animations for eyes (might roll this up into other sections/other pages?)

=== Attacks ===

'''TODO''': Links to or docs on attacks system and export, tagging, etc - related partly to animations. 

'''TODO''': Possibly also scripting attacks and animations, and character-bound input, etc - though maybe that should be in a different section?

Custom Characters

2018-03-27T07:34:00Z

Mng: /* Overview */ Removed '''TODO: Is this required?'''

'''TODO: Put this link graciously provided by Markuss in its appropriate section:''' 
https://cdn.wolfire.com/techsupport/ExampleMan.zip 

'''TODO: Write introduction'''

== Overview ==

[[Image:custom_character_file_structure.png|right|thumb|caption|All required files and what they contain]]

Characters in overgrowth consist of the following files.

{| class="wikitable"
|-
! Name !! File format !! Description
|-
! Script
| XML || Links the character xml with an AI script
|-
! Character
| XML || Links an object xml with rigging data, animations and attacks
|-
! Object
| XML || A regular object xml file, links to a model and textures
|-
! Rigging data
| XML || Links a model and a skeleton together so the model can be animated
|-
! Textures
| TGA || The textures used by the character
|-
! Model
| OBJ || The 3D mesh used by the character
|-
! Hull
| OBJ || The simplified collision to use for the character
|-
! Skeleton
| PHXBN || The bone structure used by the character for animation
|-
! Ragdoll collision
| FZX || Convex hulls used for ragdoll physics
|}

'''TODO: Link all the below steps to parts of this page'''

To create a character for Overgrowth you need to..
# Model and texture the character
# '''Optional:''' Create a simplified hull model for collision.
:::'''Note:''' Thrown weapons won't collide with characters if they don't have a hull-object.
# Rig the character using one of the included skeletons
# '''TODO: What do you need to export? The skeleton? Only the weight painted mesh?'''
# Create an object XML linking the model and the texture
# Create a rigging data XML linking the model and the skeleton
# Create a character XML linking the rigging data XML and the object XML with a set of attacks and animations the character should use
# Create a script XML linking the character XML with an AI script

The final script XML is the file that's actually loaded in the game to create the character. This article goes through all the above steps.

== Model and Texture Considerations ==
[[Image:ExampleMan_mesh.jpg|thumb|Character Model Faces Z-axis and has reset ]]
The model and textures for the character have the same requirements as when creating any other [[3D Objects|3D Object]], but with a few extra considerations.

It's extra important for characters that the model is centered to the middle of the scene, standing on the grid floor with location and rotation set to zero, and scale set to one. It should loosely match the pose and proportions of the Overgrowth characters, you can use the following file for pose and size reference: ''../Overgrowth/Data/Models/Characters/Rabbit/rabbit.obj''.

There is no character shader that supports tangent space normal maps. If you want to use a tangent space normal map anyway, the cubemap shader can be used. Though doing so will make the object look a bit different in the engine. More information about these shaders can be found in the [[3D_Objects#Shaders|3D Objects]] article.

[[Image:ExampleMan_Norm.jpg|thumb|This is what a Blank/Flat object-space normal map might look like]]

=== Fur Fins ===
'''TODO:''' Write about how fur fins work

== Rigging the Character ==
Overgrowth uses a custom skeleton format for characters with the PHXBN (Phoenix Bone '''TODO: Is this correct?''') file ending. To create this file you need to use Wolfire's custom export addons for Blender. A repackaged version of Blender for Windows with the export addons and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here]. You may need to restart the program once to get the export options to show up.

'''TODO: How do you set this up yourself, if you're not using Windows for instance?'''

This article won't teach you how to use Blender, it only gives the information essential to get a character into the game. If you need to learn the basics of Blender, [https://cgcookie.com CG Cookie] has a good free video tutorial series that introduces you to the software.

Here are the steps you need to take in Blender to create the PHXBN file:

# '''TODO: What file is supposed to be used as a base? It's probably already loaded by default in the custom Blender version that can be downloaded above, but what file is that actually? So people can set this up on their own if they want.'''
# Replace the white rabbit
#* Press '''File > Import > Wavefront (.obj)''' to import an obj file.
# Bind your own mesh to the skeleton
#* First select the mesh, then shift-select the skeleton to add it to your selection before you press Ctrl + P to bind them.
# Paint weights
#* You may want to look up a tutorial on painting weights in blender.
#* It is recommended that you test your character in engine with automatic weights to check that you have no errors before you start working on a final weight paint. It won’t look pretty, but will let you know early on if the character is going to work in the engine.
# Export your files
#* With skeleton selected in object mode, export as .PHXBN, same for mesh but as .OBJ. Your model needs to be in rest position when doing this.

== Object XML ==
- A regular object file as described in the [[3D_Objects#Basics | 3D reference guide]].
<pre>
<?xml version="1.0"?>
<Object>
<Model>Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj</Model>
<ColorMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Color.TGA</ColorMap>
<NormalMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Norm.TGA</NormalMap>
<ShaderName>cubemapobjchar</ShaderName>
</Object>
</pre>

== Rigging data XML ==
- Links to the .OBJ and .PHXBN files that the engine needs to rig the character.
<pre>
<?xml version="1.0" ?>
<rig bone_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.phxbn"
model_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj"/>
</pre>

== Character XML ==
- Links to the first 2 files, and a load of animation files for each action.
<pre>
<?xml version="1.0" ?>
<character>
<appearance obj_path = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_Object.xml"
skeleton = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_RigFiles.xml"/>
<animations idle = "Data/Animations/r_idle2.xml"
jump = "Data/Animations/r_jump.xml"
roll = "Data/Animations/r_roll.xml"
movement = "Data/Animations/r_movement.xml"
wall = "Data/Animations/r_wall.xml"
ledge = "Data/Animations/r_ledge.anm"
medrightblock = "Data/Animations/r_activeblockmedright.anm"
medleftblock = "Data/Animations/r_activeblockmedleft.anm"
highrightblock = "Data/Animations/r_activeblockhighright.anm"
highleftblock = "Data/Animations/r_activeblockhighleft.anm"
lowrightblock = "Data/Animations/r_activeblocklowright.anm"
lowleftblock = "Data/Animations/r_activeblocklowleft.anm"
blockflinch = "Data/Animations/r_activeblockflinch.anm"/>
<attacks moving_close = "Data/Attacks/haymaker.xml"
stationary_close = "Data/Attacks/thrustpunch.xml"
moving = "Data/Attacks/spinkick.xml"
stationary = "Data/Attacks/frontkick.xml"
moving_low = "Data/Attacks/soccerkick.xml"
low = "Data/Attacks/sweep.xml"
air = "Data/Attacks/legcannon.xml" />
</character>
</pre>

== Script XML ==
- Links to the third file and an AI script, this is the file you choose when loading a character.
<pre>
<?xml version="1.0" ?>
<Actor>
<Character>Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_AnimList.xml</Character>
<ControlScript>enemycontrol.as</ControlScript>
</Actor>
</pre>

== Adding Characters to the spawner menu ==

Short version:
* You must add it in a mod.
* You can add as many characters to the spawner menu as you want in a single mod, you just need to follow the below instructions for each, and add multiple <code><Item></code> tags to your mod.xml file.

In your mod.xml file, add this xml tag:
('''TODO''': Make these paths more specific to characters)

<pre><Item category="My Custom Mod Characters"
title="Some Character To Spawn"
path="Data/Objects/example_item_pack/mod_item_example.xml"
thumbnail="Data/UI/example_item_pack/thumbs/mod_item_example.png" /></pre>

* '''<code>category</code>''' is the top level category where the character will show up, in the '''Load''' menu.
* '''<code>title</code>''' is the name of the character, as it will show up in the spawner menu.
* '''<code>path</code>''' is the path to the character XML that will get spawned. See [[#How_to_create_a_character|the '''How to create a character''' section]] for which XML file to target (either the character XML itself, or a version you saved off that has modified default parameters). '''TODO''': Be careful to advise ''which'' character XML to add to the spawner - there are multiple character XML files!
* '''<code>thumbnail</code>''' is the image that will be used for a tooltip when you hover over your character in the spawner menu.

See '''<code>GameInstallDir/Data/ExampleMods/mod_xml_specification.txt</code>''' for full information.

== TODOs ==
'''TODO: Make sure all these headings are covered in this or some other article that we link to'''

=== File path conventions ===

'''TODO''': Description of where to add files in mods so they don't conflict. Ala [[Hotspots#File_path_conventions]]

=== Hull ===

'''TODO''': Links to or docs on character hulls

=== Animations ===

'''TODO''': Links to or docs on animations and export, tagging, etc

=== Morph targets ===

'''TODO''': Links to or docs on morph target animations for hands, face, etc

=== Eyes ===

'''TODO''': Links to or docs on morph target animations for eyes (might roll this up into other sections/other pages?)

=== Attacks ===

'''TODO''': Links to or docs on attacks system and export, tagging, etc - related partly to animations. 

'''TODO''': Possibly also scripting attacks and animations, and character-bound input, etc - though maybe that should be in a different section?

Checkpoints

2018-03-13T15:18:38Z

Mng: /* Pre/post goal actions */ Added "music_layer_override action"; Added '''Instructions:''' to all actions /* Pre/post goal actions table */ Added link to "music_layer_override action"; Edited table contents.

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>'''Settings → Debug → Draw In-Game 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]]

Checkpoints

2018-03-13T14:15:49Z

Mng: /* dialogue action */ Edited layout.

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>'''Settings → Debug → Draw In-Game 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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

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

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

Checkpoints

2018-03-13T14:12:03Z

Mng: /* Goals Table, no_delay modifier */ Removed " Useful in combination with the play_success_sting action."; Added " TODO: How/when is this useful?"

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>'''Settings → Debug → Draw In-Game 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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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====
'''Instructions:'''

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

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

Checkpoints

2018-03-13T14:03:44Z

Mng: /* dialogue_fade & dialogue_fade_if_not_hostile actions */ Edited Link

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# 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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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====
'''Instructions:'''

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

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

Checkpoints

2018-03-13T14:03:02Z

Mng: /* Pre/post goal actions table */ Added links to "dialogue_fade & dialogue_fade_if_not_hostile action"

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# 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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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====
'''Instructions:'''

Do all the same steps as for the [[Checkpoints#dialogue_action|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</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>.

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

Checkpoints

2018-03-13T13:59:01Z

Mng: /* dialogue action */ Added dialogue_fade & dialogue_fade_if_not_hostile actions reference; Edited dialogue action note

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# 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
|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_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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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====
'''Instructions:'''

Do all the same steps as for the [[Checkpoints#dialogue_action|dialogue action]], but add <code>'''dialogue_fade'''</code> or <code>'''dialogue_fade_if_not_hostile'''</code> to the value slot of the <code>'''goal_<number>_pre/post'''</code> script parameter instead of <code>'''dialogue'''</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>.

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

Custom Decals

2018-03-10T17:18:45Z

Mng: Removed all TODO's: '''TODO: is this necessary or are there fallback files?'''; '''TOOD: Confirm''' (x 3); Must have the same dimensions as the texture file. '''TODO: is this True?'''

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

[[File:Decal blood.jpg|thumb|alt=Decal blood plats|Decal blood splats]]
Decals are textures which can be mapped to environment objects & terrain. Their main use is adding detail and variation to the scenery. Blood splats, [[Lighting#Shadow_decals|ambient shadows]] and footprints use them too.

== Files ==
To create a custom decal, the following files are needed:

* '''[[#XML_File|XML File]]''' - What you select when loading the decal
* '''[[#ColorMap|ColorMap]]''' - The texture for the decal
* '''[[#NormalMap|NormalMap]]''' - Has normal information for the decal

=== XML File ===
This file is what you load in the engine to make the decal show up. It links to a color texture and a normal texture that make up the decal. To avoid issues we recommend using .tga as texture format, though .png works most of the time as well.

<pre style="white-space: pre-wrap;">
<?xml version="2.0" ?>
<Type>generic</Type>
<DecalObject>
<ColorMap>Data/Textures/Decals/Rocky/black_dust_c.tga</ColorMap>
<NormalMap>Data/Textures/diffusebump.tga</NormalMap>
<ShaderName>decal</ShaderName>
</DecalObject>
</pre>

{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! ColorMap
| <ColorMap>Data/Textures/MyColorMap.tga</ColorMap> || path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <NormalMap>Data/Textures/MyNormalMap.tga</NormalMap> || Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <ShaderName>decal</ShaderName> || Name of shader to use from ../Overgrowth/Data/GLSL/ (.frag and .vert)
|-
|}
=== ColorMap ===
Can be created with any image manipulation program. Should have sidelengths of a power of two pixels (e.g. 512px x 512px), else an error will appear.

=== NormalMap ===
Can be created with any image manipulation program. It's dimensions must be of a power of two pixels (e.g. 512px x 512px).

Custom Decals

2018-03-10T16:54:05Z

Mng: /* ColorMap */ Added power of two clarification

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

[[File:Decal blood.jpg|thumb|alt=Decal blood plats|Decal blood splats]]
Decals are textures which can be mapped to environment objects & terrain. Their main use is adding detail and variation to the scenery. Blood splats, [[Lighting#Shadow_decals|ambient shadows]] and footprints use them too.

== Files ==
To create a custom decal, the following files are needed:

* '''[[#XML_File|XML File]]''' - What you select when loading the decal
* '''[[#ColorMap|ColorMap]]''' - The texture for the decal
* '''[[#NormalMap|NormalMap]]''' - Has normal information for the decal '''TODO: is this necessary or are there fallback files?'''

=== XML File ===
This file is what you load in the engine to make the decal show up. It links to a color texture and a normal texture that make up the decal. To avoid issues we recommend using .tga as texture format, though .png works most of the time as well.

<pre style="white-space: pre-wrap;">
<?xml version="2.0" ?>
<Type>generic</Type>
<DecalObject>
<ColorMap>Data/Textures/Decals/Rocky/black_dust_c.tga</ColorMap>
<NormalMap>Data/Textures/diffusebump.tga</NormalMap>
<ShaderName>decal</ShaderName>
</DecalObject>
</pre>

{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! ColorMap
| <ColorMap>Data/Textures/MyColorMap.tga</ColorMap> || path to the color texture file (.tga, .tif or .png)'''TOOD: Confirm'''
|-
! NormalMap
| <NormalMap>Data/Textures/MyNormalMap.tga</NormalMap> || Path to the normal map texture file (.tga, .tif or .png)'''TOOD: Confirm'''
|-
! ShaderName
| <ShaderName>decal</ShaderName> || Name of shader to use from ../Overgrowth/Data/GLSL/ (.frag and .vert)'''TOOD: Confirm'''
|-
|}
=== ColorMap ===
Can be created with any image manipulation program. Should have sidelengths of a power of two pixels (e.g. 512px x 512px), else an error will appear.

=== NormalMap ===
Can be created with any image manipulation program. Must have the same dimensions as the texture file. '''TODO: is this True?'''

Checkpoints

2018-03-10T15:45:15Z

Mng: /* no_delay modifier */ Added TODO: COuldn't confirm this sth's wrong

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it '''TODO: COuldn't confirm this sth's wrong --[[User:Mng|Mng]] 15:45, 10 March 2018 (UTC)'''
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

===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_<goalnumber>_post'''</code> (or <code>'''goal_<number>_pre'''</code>) parameter to the overgrowth_level hotspot and set the value to <code>'''play_success_sting'''</code>.The goalnumber parameter is goal from step 1 that you want the action to be triggered after (or before)

'''Note:''' If the success_sting is a <code>'''goal_<goalnumber>_post'''</code> action and the the next <code>'''goal_<number>_pre'''</code> action is "[[#dialogue_action|dialogue]]", the [[#no_delay_modifier|no_delay modifier]] is needed in order to hear it before the dialogue starts. '''TODO: COuldn't confirm this, something's wrong. --[[User:Mng|Mng]] 15:43, 10 March 2018 (UTC)'''

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

Checkpoints

2018-03-10T15:43:31Z

Mng: /* play_success_sting action */

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

===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_<goalnumber>_post'''</code> (or <code>'''goal_<number>_pre'''</code>) parameter to the overgrowth_level hotspot and set the value to <code>'''play_success_sting'''</code>.The goalnumber parameter is goal from step 1 that you want the action to be triggered after (or before)

'''Note:''' If the success_sting is a <code>'''goal_<goalnumber>_post'''</code> action and the the next <code>'''goal_<number>_pre'''</code> action is "[[#dialogue_action|dialogue]]", the [[#no_delay_modifier|no_delay modifier]] is needed in order to hear it before the dialogue starts. '''TODO: COuldn't confirm this, something's wrong. --[[User:Mng|Mng]] 15:43, 10 March 2018 (UTC)'''

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

Checkpoints

2018-03-10T13:57:03Z

Mng: /* play_success_sting action */ Added "You can combine this with other actions."

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

===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_<goalnumber>_post'''</code> (or <code>'''goal_<number>_pre'''</code>) parameter to the overgrowth_level hotspot and set the value to <code>'''play_success_sting'''</code>.The goalnumber parameter is goal from step 1 that you want the action to be triggered after (or before)

'''Note:''' If the success_sting is a <code>'''goal_<goalnumber>_post'''</code> action and the the next <code>'''goal_<number>_pre'''</code> action is "[[#dialogue_action|dialogue]]", the [[#no_delay_modifier|no_delay modifier]] is needed in order to hear it before the dialogue starts.

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

Checkpoints

2018-03-10T13:54:31Z

Mng: /* Pre/post goal actions */ Added play_success_sting action reference

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

'''Instructions''':

# Set up the goal that you want this action to be triggered by
# Add a <code>'''goal_<goalnumber>_post'''</code> (or <code>'''goal_<number>_pre'''</code>) parameter to the overgrowth_level hotspot and set the value to <code>'''play_success_sting'''</code>.The goalnumber parameter is goal from step 1 that you want the action to be triggered after (or before)

'''Note:''' If the success_sting is a <code>'''goal_<goalnumber>_post'''</code> action and the the next <code>'''goal_<number>_pre'''</code> action is "[[#dialogue_action|dialogue]]", the [[#no_delay_modifier|no_delay modifier]] is needed in order to hear it before the dialogue starts.

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

Checkpoints

2018-03-10T13:26:59Z

Mng: /* Goals */ Added link to #play_success_sting

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>'''Settings → Debug → Draw In-Game 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. Useful in combination with the [[#play_success_sting|play_success_sting]] action.
|}

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

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

Checkpoints

2018-03-10T13:22:07Z

Mng: /* no_delay modifier */ Formatting

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>'''Settings → Debug → Draw In-Game 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 ===

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

Custom Decals

2018-03-10T13:20:28Z

Mng: Replaced tag desc with table

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

[[File:Decal blood.jpg|thumb|alt=Decal blood plats|Decal blood splats]]
Decals are textures which can be mapped to environment objects & terrain. Their main use is adding detail and variation to the scenery. Blood splats, [[Lighting#Shadow_decals|ambient shadows]] and footprints use them too.

== Files ==
To create a custom decal, the following files are needed:

* '''[[#XML_File|XML File]]''' - What you select when loading the decal
* '''[[#ColorMap|ColorMap]]''' - The texture for the decal
* '''[[#NormalMap|NormalMap]]''' - Has normal information for the decal '''TODO: is this necessary or are there fallback files?'''

=== XML File ===
This file is what you load in the engine to make the decal show up. It links to a color texture and a normal texture that make up the decal. To avoid issues we recommend using .tga as texture format, though .png works most of the time as well.

<pre style="white-space: pre-wrap;">
<?xml version="2.0" ?>
<Type>generic</Type>
<DecalObject>
<ColorMap>Data/Textures/Decals/Rocky/black_dust_c.tga</ColorMap>
<NormalMap>Data/Textures/diffusebump.tga</NormalMap>
<ShaderName>decal</ShaderName>
</DecalObject>
</pre>

{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! ColorMap
| <ColorMap>Data/Textures/MyColorMap.tga</ColorMap> || path to the color texture file (.tga, .tif or .png)'''TOOD: Confirm'''
|-
! NormalMap
| <NormalMap>Data/Textures/MyNormalMap.tga</NormalMap> || Path to the normal map texture file (.tga, .tif or .png)'''TOOD: Confirm'''
|-
! ShaderName
| <ShaderName>decal</ShaderName> || Name of shader to use from ../Overgrowth/Data/GLSL/ (.frag and .vert)'''TOOD: Confirm'''
|-
|}
=== ColorMap ===
Can be created with any image manipulation program.

=== NormalMap ===
Can be created with any image manipulation program. Must have the same dimensions as the texture file. '''TODO: is this True?'''

Checkpoints

2018-03-10T00:57:50Z

Mng: /* Goals */ Added no_delay reference

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>'''Settings → Debug → Draw In-Game 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 ===

# Add a <code>'''goal_<number>'''</code> and two corresponding <code>'''goal_<number>_pre/post'''</code> actions 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 with a one space wide gap to it
'''Example:'''
{| class = wikitable
! Script Param !! Value
|-
|goal_2_pre || dialogue_fade "Stranger"
|-
|goal_2 || defeat 363 '''no_delay'''
|-
|goal_2_post || play_success_sting
|}
'''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
|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_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
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

Checkpoints

2018-03-10T00:00:50Z

Mng: /* Pre/post goal actions */ fixed table mess-up

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>'''Settings → Debug → Draw In-Game 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
|this is a modifier you can put after any '''defeat''' goal, to reduce the time to 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>

== 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
|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_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
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

Checkpoints

2018-03-09T23:59:37Z

Mng: /* Pre/post goal actions */ Added use of dialogue_fade_if_not_hostile; removed '''TODO''': Not sure why this is useful?

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>'''Settings → Debug → Draw In-Game 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
|this is a modifier you can put after any '''defeat''' goal, to reduce the time to 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>

== 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
|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_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
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

Checkpoints

2018-03-09T23:51:16Z

Mng: Added to category Tutorials

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>'''Settings → Debug → Draw In-Game 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
|this is a modifier you can put after any '''defeat''' goal, to reduce the time to 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>

== 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
|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_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 ('''TODO''': Not sure why this is useful?)
|-
|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
|force play of the given music track layer. Set to the appropriate layer number to force a certain layer to be played, 0 is calmest, 1 is more intense and so on. Set to <code>'''-1'''</code> to let the game select based on the activity level. Set to <code>'''-2'''</code> for silence ('''TODO''': Is this correct for -2?)
|}

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

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

# 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 that for a <code>'''goal_<goalnumber>_pre'''</code> action, the 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>)

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

My First Mod

2018-03-09T23:00:01Z

Mng: Abandoned, redirected to Creating a new Mod; removed "Lets make a mod where we create our own hotspot."

#REDIRECT[[Creating a new Mod]]

Creating a new Mod

2018-03-09T22:58:20Z

Mng: Added to category Tutorials

== Folder structure ==

Overgrowth has a powerful and simple system to allow the creation of mods by both "overshadowing" existing files, and by creating new files.

Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There, each mod folder has a readable name.

The folder for a mod must contain at least a mod.xml file. Other data may be present as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mod's folder, resulting in the following structure

Overgrowth/Data/Mods/
└── my_mod/
├── mod.xml
└── Data/
├── Scripts/
├── Shaders/
├── Models/
├── Textures/
└── Levels/

Note that your mod can be set up and kept in either YourPC/Documents/Wolfire/Overgrowth/Data/Mods, or in the actual program files, in YourPC/(C:)/Program Files(x86)/Steam/steamapps/common/Overgrowth/Data/Mods - both of these "Mods" folder locations will work. The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].

== The mod.xml file ==

The mod.xml file contains the mod's meta data. The game uses this file to understand how to use the mod with the game. XML files can be written and modified using programs like Notepad++ and Sublime Text. Here is a complete example:

<? xml version="1.0" ?>
<Mod>

<Id>unique-name</Id>

<Name>Human Readable Name</Name>

<Version>1.2.5</Version>
<SupportedVersion>b4</SupportedVersion>
<ModDependency>
<Id>other-mod2</Id>
<Version>1.0.0</Version>
</ModDependency>
</Mod>

You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.

== mod.xml tags ==
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.

=== Id ===

The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency. ID tag text must consist of letters and dashes only, with no uppercase.

Example:
<code><Id>my-mod</Id></code>

=== Name ===

The name of the mod, shown in the mod menu.

Example:
<code><Name>My Mod</Name></code>

=== Category ===

Required for a valid mod, but does not have any effect.

Example:
<code><Category>Campaign</Category></code>

=== Author ===

Is shown in the user interface to tell the user who made the mod.

Example:
<code><Author>John Doe</Author></code>

=== Description ===

Is shown in the user interface to tell the user what this mod does.

Example:
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code>

=== Version ===

The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.

Example:
<code><Version>1.0.0</Version></code>

=== Thumbnail ===

The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.

Example:
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code>

=== PreviewImage ===

This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.

Example:
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code>

=== Tag ===

Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.

Example:
<Tag>Campaign</Tag>
<Tag>Parkour</Tag>

=== SupportedVersion ===

Which version of the game this mod can be used in. Can be something like <code>1.2.0</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.

To find out which version of the game you're running, in the top menu bar, press <code>Help → About...</code>. Here you will see 4 lines of information, where the third line shows your version number. It starts with three numbers separated by periods, and this is the version you're running. It can for example be <code>1.2.0</code>.

Example:
<code><SupportedVersion>1.2.0</SupportedVersion></code>

=== LevelHookFile ===

Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.

Example:
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code>

=== MenuItem ===
Deprecated, no longer works.

Adds a campaign button to the Play menu which runs a script. The script type is a [[Scriptable Menu]].

Example:
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code>

=== Campaign ===

Describes a set of levels that belong together.

Has a few attributes that describe the campaign:

{| class="wikitable"
|-
! Attribute !! Purpose
|-
! title
| The name of the campaign, shown in the menu.
|-
! type
| Deprecated, has no effect.
|-
! is_linear
| Sets if you need to finish the first level to unlock access to the second and so on.
|-
! thumbnail
| The path to the image to use for the campaign in the play menu.
|}

Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.

Example:
<Campaign title="My Campaign"
type="general"
is_linear="true">
<Level title="Intro"
thumbnail="Images/MyMod/intro_thumb.jpg">
MyMod/intro.xml
</Level>
<Level title="Big Challenge"
thumbnail="Images/MyMod/challenge_thumb.jpg">
MyMod/challenge.xml
</Level>
<Level title="Ending"
thumbnail="Images/MyMod/end_cutscene_thumb.jpg">
MyMod/end_cutscene.xml
</Level>
</Campaign>

=== Level ===

Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.

Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.

Attributes:
{| class="wikitable"
|-
! Attribute !! Purpose
|-
! title
| The name of the level, shown in the menu.
|-
! thumbnail
| The path to the image to use for the level in the play menu. This attribute is not required.
|}

Example:
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code>

=== NeedsRestart ===

This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.

Can be <code>true</code> or <code>false</code>.

You need to manually test for if your mod works properly without a game restart, and then put true or false depending on the outcome.

Example:
<code><NeedsRestart>false</NeedsRestart></code>

=== ModDependency ===

This is a list of other mods that this mod depends on to work. Has two tags for each mod:

{| class="wikitable"
|-
! Tag !! Purpose
|-
! Id
| The unique ID for the other mod.
|-
! Version
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.
|}

Example:
<ModDependency>
<Id>other-mod</Id>
<Version>1.0.0</Version>
</ModDependency>

=== Item ===

Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.

Has a few attributes for each entry:

{| class="wikitable"
|-
! Attribute !! Purpose
|-
! category
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.
|-
! title
| Name of the item to display in the list.
|-
! path
| Path to the object file for this item.
|-
! thumbnail
| Path to image to use as a preview image for this item.
|}

Example:
<Item category="My Mod"
title="My item"
path="Data/Items/MyItem.xml"
thumbnail="Data/UI/spawner/MyItem.png" />

== Advanced mod menu ==

[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]

To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.

This shows all the available information for the selected mod.

== Steam Workshop ==

Overgrowth comes with built in tools for uploading your mods to the Steam Workshop.

=== Uploading a Mod ===

[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]

To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.

If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.

Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.

If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".

=== Updating a Mod ===

To update a mod that you've already uploaded to Steam Workshop, start by opening up the [[#Advanced_mod_menu|advanced mod menu]]. Select the workshop mod you want to update under the "My Steam Workshop Mods" heading in the left column, and press "Upload Update..." under "Owner Controls" in the right column.

This brings up a window where you can choose which local source mod to use as the updated version, you can control its visibility on the workshop and write an update message. After agreeing to the text at the bottom of the window you can upload the update.

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

NPC Navigation

2018-03-09T22:54:44Z

Mng: Added to category: Modding, Overgrowth

Overgrowth will automatically make sure that there is a navigation mesh for a level when you start it. However, this mesh might not be like you want it. For instance, maybe the NPCs can run up places they shouldn't, or they can't access some place of the level because they don't know where to jump since there are no jump nodes. This article goes through the tools you can use improve the way NPCs navigate through your levels.

= Visualizing Navigation =
[[Image:Nav_mesh_vis.jpg|right|thumb|caption|Nav mesh visualization]]

There are a number of useful visualizations you can use to see what's going on with the nav mesh and jump nodes. These are all available in the top menu bar under ''View''.

{| class="wikitable"
|-
! Option !! Description
|-
! Nav mesh
| The areas that are considered walkable
|-
! Collision
| What geometry the nav mesh generator took into consideration when the current nav mesh was generated
|-
! Nav hints
| Display [[#Nav_Hints|nav hints]]
|-
! Nav regions
| Display [[#Nav_Regions|nav regions]]
|-
! Jump nodes
| Display [[#Jump_Nodes|jump nodes]]
|}

= Generating The Nav Mesh =
In the editor, in the menu bar under ''Nav Mesh'' you have a button to create, save and load the nav mesh, as well as a number of parameters that decides how the nav mesh is generated.

Overgrowth uses the Recast navigation mesh construction toolset to create it's nav meshes. The first step Recast takes when constructing the nav mesh is to create a voxel representation of the level geometry. It then uses that to figure out where a character should be able to walk.

All distance values in the nav mesh parameters refer to meters.

{| class="wikitable"
|-
! Nav Mesh Parameter !! Description !! Default value
|-
! Cell Size
| The width and depth of each voxel in the voxel step, a smaller number results in a more detailed and accurate nav mesh, but also increases generation time
| 0.30
|-
! Cell Height
| The height of each voxel in the voxel step, a smaller number results in a more detailed and accurate nav mesh, but also increases generation time
| 0.20
|-
! Agent Height
| How much ceiling height the characters in the game need
| 1.70
|-
! Agent Radius
| How wide the characters in the game are, this value higher than the characters in the game actually are (they are not actually 0.8m wide), because movement in OG has so much momentum that there needs to be some extra margin to ensure characters can navigate well
| 0.40
|-
! Agent Max Climb
| The tallest "stair" characters should be able to walk up, this is quite high by default to ensure the AI can get around easily by default, but once you start working on the nav mesh and jump nodes you can turn this down to around 0.70 and just make sure you handle all navigation issues that arise
| 1.50
|-
! Agent Max Slope
| The steepest angle that should be considered walkable
| 60.00
|}

= Nav Hints =
[[Image:nav_hint.jpg|right|thumb|caption|Left side: nav hint and the resulting nav mesh, right side: what the nav generator sees]]

Sometimes you want to stop the nav generator from creating a walkable area somewhere, like if you don't want your NPCs to think they can walk under water. Other times the nav generator doesn't create a walkable area somewhere where NPCs should clearly be able to walk, maybe because there is some complicated geometry there. These types of issues can be solved using nav hints.

Nav hints are blocks that are only seen by the nav generator. So in the game they are invisible and passable, they ONLY matter when the nav mesh is generated.

Create a nav hint by going to ''Load → Utility → nav hint'' in the top menu bar. Once you click to place it you'll see a purple wireframe box that you can translate, rotate and scale. When the nav mesh is being generated it will regard this wirefram box as a solid block, so use it to block off or bridge over problematic areas.

Note that as with any box, navigation will still be generated inside the box, since Recast only considers the walls of any object solid.

If you want to see exactly what the nav generator sees, generate the nav mesh and then activate ''View → Collision''. This shows the collision the nav generator used the last time it generated the nav mesh.

= Nav Regions =
[[Image:nav_region.jpg|right|thumb|caption|The nav region limits the nav mesh area, improving the nav mesh generation times significantly]]

If you have a really big level, you might not want to generate navigation for all of it. Maybe the outer parts are an inaccessible backdrop or won't ever have any NPCs in it. This is where using a nav region is useful.

Once a nav region is placed, the nav mesh will only be generated inside that region. This can cut down on nav generation times a lot, and so can also be used to temporarliy get quicker nav generation times while working on a specific part of a level. Keep in mind though that moving the nav region can slightly change how the mesh is generated.

To create a nav region, go to ''Load → Utility → nav region'' in the top menu bar. It looks like a purple box, and can only be scaled and translated, not rotated. Simply scale and position the box so that all of the area you want to have nav mesh is covered.

A level can only have one nav region, any extra nav regions are ignored.

= Jump Nodes =
[[Image:jump_nodes.jpg|right|thumb|caption|Some connected jump nodes]]

To tell NPCs to where they can jump you need to place jump nodes and connect them to each other.

To create a jump connection, create a jump node via ''Load → Utility → nav connection'' in the top menu bar. Once you have two jump nodes, slect one of them and hold alt while left clicking on the other to connect them to each other. When you generate the nav mesh the next time, these nodes will be positions that NPCs can jump to and from.

One jump node can have more than one connection.

Keep in mind that almost all jump nodes need to work both ways. If you make a really tall jump connection for instance, NPCs will be able to jump down, but since it's so tall, they will not be able to jump up. Since the connection is there, they will still try to jump up if it would be the fastest route. However, when they realize they can't jump that high, they will just stand on the jump node instead of trying to find anoter way. This is why you need to manually test your jump nodes to make sure they actually work both ways.

There are some cases when jump nodes do not need to work both ways. For instance, if an NPC is spawned outside of the playable area, quite far up, where it will never have any possible reason to return, it could make sense to have a jump connection that only works in one direction. This is because then the NPC will never get stuck on the bottom jump node, because there will never be a case where the NPC would need to use it.

= Testing Navigation =
[[Image:nav_testing.jpg|right|thumb|caption|AI path and jump visualization]]

To ensure that your jump nodes and nav mesh works as you expect you'll want to test it using debug tools.

To test navigation, in the top menu bar, press ''Settings → Debug → AI'' and activate ''Show AI Path'' to see where NPCs are going, ''Show AI Jump'' to see a visualization of where they are trying to jump, and ''AI Mouse Path Testing'' to be able to tell AI where to go.

Once you've activated the debug settings, select a character spawn point, point with the cursor where you want the character to go and press G.

This allows you to easily test if your navigation is working as expected. This is an especially useful method to test jump connections with.

You might want to deactivate the AI when doing this by pressing C. Otherwise the character you are testing with might get killed by some enemies in the level.

Keeping the ''AI Mouse Path Testing'' setting activated can degrade performance in the editor quite a bit, so make sure to turn it off after you're done testing your nav mesh.

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

How To Report a Bug in Overgrowth

2018-03-09T22:52:57Z

Mng: Added to category: Overgrowth

Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.

== General Information ==

To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.

* What version of the game you're running, including where you downloaded the game and if you're running the stable release or some other test version.
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor (if any).
* What operating system you are running, and what version.

== Files we are interested in ==

While running, the game writes multiple files into a local cache directory, in those there is information that is useful to us when solving your issue.

Depending on your operating system (Windows, Linux or Mac) the local cache directory will be in a different place, following are the directories for the respective operating system.

* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Overgrowth/</code>. Where '~' is your username.
* Windows: <code>My Documents\Wolfire\Overgrowth\</code>
* Linux: <code>~/.local/share/Overgrowth/</code>

In the cache directory there are primarily two files we are interested in.

* '''Data/hwreport.txt''' - Contains information about what hardware your computer contains.
* '''logfile.txt''' - Logfile of the games execution.

If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.

== Finally ==

Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.

We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.

And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.

[[Category: Overgrowth]]

Custom Decals

2018-03-09T17:12:20Z

Mng: /*Top*/ Added Image Decal_blood.jpg

[[File:Decal blood.jpg|thumb|alt=Decal blood plats|Decal blood splats]]
Decals are textures which can be mapped to environment objects & terrain in Edit Mode. Their main use is adding detail to the scenary; bloodsplats, [[Lighting#Shadow_decals|shadows]] and footprints use them too.

=Files=
To create a custom decal, the following files are needed:

* '''[[#XML_File|XML File]]''' - What you select when loading the decal
** '''[[#Normal_Map_Image_File|Color Map File]]''' - The texture for the decal
** '''[[#Texture_File|Normal Map File]]''' - Has normal information for the decal '''TODO: is this necessary or are there fallback files?'''

===XML File===

<pre style="white-space: pre-wrap;"><?xml version="2.0" ?>
<Type>generic</Type>
<DecalObject>
<ColorMap>Data/Textures/Decals/Rocky/black_dust_c.tga</ColorMap>
<NormalMap>Data/Textures/diffusebump.tga</NormalMap>
<ShaderName>decal</ShaderName>
</DecalObject>
</pre>

'''ColorMap''' 
Path to the texture file.

'''NormalMap''' 
Path to the Normal map image file.

===Texture File===
Can be created with any image manipulation program. Has to be quadratic. '''TODO: is this True?'''
The following file formats are supported:
* *.tga
* *.png
* *.jpeg '''TODO: is this True?'''
'''TODO: add the rest.'''

===Normal Map Image File===
Can be created with any image manipulation program. Must have the same dimensions as the texture file. '''TODO: is this True?'''

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

File:Decal blood.jpg

2018-03-09T17:04:58Z

Mng: Decal bloodsplats

Decal bloodsplats

Custom Decals

2018-03-09T14:30:33Z

Mng: Added basic layout; Removed "{{stub}} Tutorial on how to create and import custom decals into Overgrowth: * http://forums.wolfire.com/viewtopic.php?f=13&t=5064&p=82123&hilit=custom+texture#p82123"

Decals are textures which can be mapped to environment objects & terrain in Edit Mode. Their main use is adding detail to the scenary; bloodsplats, [[Lighting#Shadow_decals|shadows]] and footprints use them too.

=Files=
To create a custom decal, the following files are needed:

* '''[[#XML_File|XML File]]''' - What you select when loading the decal
** '''[[#Normal_Map_Image_File|Color Map File]]''' - The texture for the decal
** '''[[#Texture_File|Normal Map File]]''' - Has normal information for the decal '''TODO: is this necessary or are there fallback files?'''

===XML File===

<pre style="white-space: pre-wrap;"><?xml version="2.0" ?>
<Type>generic</Type>
<DecalObject>
<ColorMap>Data/Textures/Decals/Rocky/black_dust_c.tga</ColorMap>
<NormalMap>Data/Textures/diffusebump.tga</NormalMap>
<ShaderName>decal</ShaderName>
</DecalObject>
</pre>

'''ColorMap''' 
Path to the texture file.

'''NormalMap''' 
Path to the Normal map image file.

===Texture File===
Can be created with any image manipulation program. Has to be quadratic. '''TODO: is this True?'''
The following file formats are supported:
* *.tga
* *.png
* *.jpeg '''TODO: is this True?'''
'''TODO: add the rest.'''

===Normal Map Image File===
Can be created with any image manipulation program. Must have the same dimensions as the texture file. '''TODO: is this True?'''

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

Lighting

2018-03-09T13:50:02Z

Mng: /* Shadow decals */ Added Link to Custom Decals; Edited Formatting

{{stub}}

== Sunlight ==
The sun allows you to cast dynamic, single-directional light throughout a level. You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

Double click the sun in the sky to select it.
Double click well outside of the sun editor to deselect it (the normal Q for "deselect all" isn't working right now)

Move the sun by clicking on the middle of it and dragging it around the sky.
Change the sun color by dragging the dot around the outer ring.
Change the sun intensity by clicking ''just'' outside the outer ring and drag it.

If you have problems clicking it, or would prefer a numeric editor, simply hit hit <kbd>Y</kbd> to open the scenegraph. Expand "level" to find the Sun parameters.

== Point lights ==
Point lights allow you to cast omni-directional light from a point in the level.

Top Bar -> Load -> Lighting -> Dynamic Light. The cursor will turn into a plus symbol. Now click in level to place the dynamic light.

To change the light's area of influence, double click it and hold E while clicking and dragging on its bounding box. Note that this only changes the light's area of influence, not how much light it outputs. So if you want to make the light cover a larger area you'll have to both make its area of influence larger, and also increase its brightness using its overbright slider.

To change the color of the light, select it and hit CTRL + P to open the "color picker". Adjust the color with the color selector, or RGB at the bottom. The "overbright" slider increases the brightness of the light.

If you need an "area light" (non-spherical) effect, you can either use shadow decals to shape the light, or you can place multiple dynamic light objects, or some combination of both. Be careful to both look at how the lights affect static objects in the scene, and how they affect characters that walk through them.

== Shadow decals ==
Shadows from sunlight are taken care of automatically. However this only allows one level of shadowing, and doesn't handle ambient occlusion (shadowing of indirect light reflections). Shadow [[Custom Decals|decals]] ("Ambient Shadows") allow you to manually place decals which simulate this ambient occlusion effect. This can help you visually anchor objects more realistically in the scene, and replicate effects like darkening around corners, and inside cubbyholes.

''Top Bar -> Load -> Lighting -> Ambient Shadow''. The cursor will turn into a plus symbol. Now click in level to place the ambient shadow decal.

Double click the ambient shadow decal, and hold E while clicking and dragging on its bounding box (or while shift + right-clicking and dragging on a side to only stretch in that direction). This will let you increase the spread of its effect.

'''Note''': Ambient shadow decals will not create shadows if they in direct light. This is because they're for simulating indirect shadowing. Direct shadowing is already handled by placing objects in the world.

[[File:Ambient shadow decals.png|600px|Ambient Shadow Decals's effect on light]]

=== Affect on dynamic lights ===

By default, no objects cast shadows from dynamic point lights. This is for performance reasons.

Normally ambient shadow decals also will not create shadow from dynamic point lights, because that would be shading direct light, and they don't work that way.

However you can use the <code>'''#SHADOW_POINT_LIGHTS'''</code> level Custom Shader to make it so shadow decals can shape point lights, so you can manually simulate this shadowing.

Hit <kbd>'''Y'''</kbd> to open the level's scenegraph, expand Script Params, and add a <code>'''Custom Shader'''</code> param, and hit Enter. Then type <code>'''#SHADOW_POINT_LIGHTS'''</code> in the value column and hit enter. This will make ambient shadows affect the direct light from dynamic lights, an let you sculpt the light they cast, or let you create manual shadows.

[[File:Shadow point lights shader disabled.png|400px|without #SHADOW_POINT_LIGHTS]]
[[File:Shadow_point_lights_shader.png|400px|#SHADOW_POINT_LIGHTS Custom Shader setting]]
[[File:Shadow_point_lights_shader_enabled.png|400px|with #SHADOW_POINT_LIGHTS]]

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

Lighting

2018-03-09T13:47:53Z

Mng: Added to categories: Tutorials | Modding | Overgrowth

{{stub}}

== Sunlight ==
The sun allows you to cast dynamic, single-directional light throughout a level. You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

Double click the sun in the sky to select it.
Double click well outside of the sun editor to deselect it (the normal Q for "deselect all" isn't working right now)

Move the sun by clicking on the middle of it and dragging it around the sky.
Change the sun color by dragging the dot around the outer ring.
Change the sun intensity by clicking ''just'' outside the outer ring and drag it.

If you have problems clicking it, or would prefer a numeric editor, simply hit hit <kbd>Y</kbd> to open the scenegraph. Expand "level" to find the Sun parameters.

== Point lights ==
Point lights allow you to cast omni-directional light from a point in the level.

Top Bar -> Load -> Lighting -> Dynamic Light. The cursor will turn into a plus symbol. Now click in level to place the dynamic light.

To change the light's area of influence, double click it and hold E while clicking and dragging on its bounding box. Note that this only changes the light's area of influence, not how much light it outputs. So if you want to make the light cover a larger area you'll have to both make its area of influence larger, and also increase its brightness using its overbright slider.

To change the color of the light, select it and hit CTRL + P to open the "color picker". Adjust the color with the color selector, or RGB at the bottom. The "overbright" slider increases the brightness of the light.

If you need an "area light" (non-spherical) effect, you can either use shadow decals to shape the light, or you can place multiple dynamic light objects, or some combination of both. Be careful to both look at how the lights affect static objects in the scene, and how they affect characters that walk through them.

== Shadow decals ==
Shadows from sunlight are taken care of automatically. However this only allows one level of shadowing, and doesn't handle ambient occlusion (shadowing of indirect light reflections). Shadow decals ("Ambient Shadows") allow you to manually place decals which simulate this ambient occlusion effect. This can help you visually anchor objects more realistically in the scene, and replicate effects like darkening around corners, and inside cubbyholes.

Top Bar -> Load -> Lighting -> Ambient Shadow. The cursor will turn into a plus symbol. Now click in level to place the ambient shadow decal.

Double click the ambient shadow decal, and hold E while clicking and dragging on its bounding box (or while shift + right-clicking and dragging on a side to only stretch in that direction). This will let you increase the spread of its effect.

'''Note''': Ambient shadow decals will not create shadows if they in direct light. This is because they're for simulating indirect shadowing. Direct shadowing is already handled by placing objects in the world.

[[File:Ambient shadow decals.png|600px|Ambient Shadow Decals's effect on light]]

=== Affect on dynamic lights ===

By default, no objects cast shadows from dynamic point lights. This is for performance reasons.

Normally ambient shadow decals also will not create shadow from dynamic point lights, because that would be shading direct light, and they don't work that way.

However you can use the <code>'''#SHADOW_POINT_LIGHTS'''</code> level Custom Shader to make it so shadow decals can shape point lights, so you can manually simulate this shadowing.

Hit <kbd>'''Y'''</kbd> to open the level's scenegraph, expand Script Params, and add a <code>'''Custom Shader'''</code> param, and hit Enter. Then type <code>'''#SHADOW_POINT_LIGHTS'''</code> in the value column and hit enter. This will make ambient shadows affect the direct light from dynamic lights, an let you sculpt the light they cast, or let you create manual shadows.

[[File:Shadow point lights shader disabled.png|400px|without #SHADOW_POINT_LIGHTS]]
[[File:Shadow_point_lights_shader.png|400px|#SHADOW_POINT_LIGHTS Custom Shader setting]]
[[File:Shadow_point_lights_shader_enabled.png|400px|with #SHADOW_POINT_LIGHTS]]

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

Decals

2018-03-09T13:36:04Z

Mng: Redirected to Custom_Decals; Removed "{{stub}} http://www.moddb.com/games/overgrowth/news/hd-video-dainty-decal-demonstration Category: Tutorials Category: Modding Category: Overgrowth"

#redirect[[Custom Decals]]

File:Receiver icon small.png

2018-03-09T13:12:28Z

Mng: Logo for Receiver, taken from the Wolfire website. '''TODO:''' Upload a better image?

Logo for Receiver, taken from the Wolfire website. '''TODO:''' Upload a better image?

Whaleman

2018-03-08T21:43:22Z

Mng: hehe

Whaleman is a user-created model.

It became popular amongst Overgrowth fans due the utter randomness it exhibits.

[[Category: Lore]]

Script Parameters

2018-03-08T21:42:02Z

Mng: Added to category: Modding, Overgrowth

:''This page covers non-hotspot object script parameters only. For hotspot specific script parameters, see [[Hotspots]]. ''

Script parameters can be set per object (and Level) and are used to pass parameters to an underlying script.

The script parameters for the selected object can be most easily changed using the [[Editor_Interface#Selected_Window|selected window]].

Some parameters might not exist by default. If that's the case you simply need to press the "New parameter" button and type in the exact same name (including big/small letters).

== Level ==
The level parameters can be accessed by bringing up the scenegraph window, expanding "Level" at the top, and then "Script Params".

{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Achievements
| string
| Decide which challenges you can complete on the level, they appear on the level end screen.
|-
! Custom Shader
| string
| Here you can specify a list of shader defines (e.g. <code>'''#TEST_CLOUDS_2 #SNOW_EVERYWHERE'''</code> - [[Shader_And_Weather_Effects#Weather_Effects.2FWorld_Shaders|full list here]]) to change how the level is rendered.
|-
! Fog amount
| float
| Sets the thicknoess of the atmosphere and thus how far you can see.
|-
! GPU Particle Field
| string
| Here you can specify a list of shader defines (e.g. <code>'''#SNOW #MED'''</code> - [[Shader_And_Weather_Effects#Particles|full list here]]) to add global particle effects.
|-
! HDR Black point
| float
| Sets what brightness should be regarded as black.
|-
! HDR Bloom multiplier
| float
| Decides how much light pixels bleed.
|-
! HDR White point
| float
| Sets what brightness should be regarded as white.
|-
! Level Boundaries
| bool
| If this is checked characters will be pushed back into the level when they try to go past a certain point.
|-
! Objectives
| string
| Set the goal of the level.
|-
! Sky Brightness
| float
| Adjust how bright the sky should be.
|-
! Sky Rotation
| int
| Move the sky around.
|-
! Sky Tint
| RGB
| Makes the sky have a specified color.
|}

== Character ==
=== Stats ===
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Attack Damage
| float
| The higher this is, the more health is taken from attacked characters.
|-
! Attack Knockback
| float
| The higher this is, the more physics force is applied to attacked characters.
|-
! Attack Speed
| float
| The higher this is, the faster attack animations play.
|-
! Damage Resistance
| float
| The higher this is, less health this character loses when it takes damage.
|-
! Knockout shield
| int
| How many times the character needs to lose their footing before they start taking real damage.
|-
! Movement Speed
| float
| How fast the character moves when running.
|}

=== AI ===
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Aggression
| float
| How often this AI should attempt to attack.
|-
! Block Follow-up
| float
| How often this AI should attempt a shoulder throw after blocking an attack.
|-
! Block Skill
| float
| How often this AI should block attacks.
|-
! Focus FOV distance
| float
| How far the AI can see, in meters.
|-
! Focus FOV horizontal
| float
| How wide the AI's field of view is, in degrees.
|-
! Focus FOV vertical
| float
| How tall the AI's field of view is, in degrees.
|-
! Peripheral FOV distance
| float
| How far the AI can see in its close proximity, in meters.
|-
! Peripheral FOV horizontal
| float
| How wide the AI's near field of view is, in degrees.
|-
! Peripheral FOV vertical
| float
| How tall the AI's near field of view is, in degrees.
|-
! Ground Aggression
| float
| How often the AI should attack an opponent that's ragdolled.
|-
! Hearing Modifier
| float
| A multiplier for the distance at which that sounds can be heard.
|-
! scared
| -
| Makes the AI run away from enemies.
|-
! Stick To Nav Mesh
| -
| Removes physics calculations for this NPC's movement to ensure they do not fall off cliffs etc.
|-
! Throw Counter Probability
| float
| Disables this NPC's ability to block shoulder throws.
|-
! Throw Trainer
| -
| Changes sound when shoulder throwing this character. If tutorials are on, it also makes the character invulnerable to jump kicks, makes them block all attacks, and sets their health really low when their KO shield is gone. This is used on the first enemy in the "Slaver Path" level in the Overgrowth story.
|-
! Weapon Catch Skill
| float
| Changes the NPC's ability to grab thrown weapons in the air.
|}

'''TODO: Exactly how does focus/peripheral FOV work?

=== Visual ===
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Character Scale
| float
| The higher this is, the bigger the character is.
|-
! Ear Size
| float
| How big the ears are.
|-
! Fat
| float
| How heavy the character is.
|-
! Left handed
| bool
| If checked, the character uses weapons in their left hand instead of their right hand.
|-
! Muscle
| float
| How bulky the character is.
|}

=== Other ===
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
! Cannot Be Disarmed
| bool
| If checked, this character cannot have its weapon taken away.
|-
! Static
| bool
| If checked, this character can't move and has no AI.
|-
! Teams
| string
| All characters that share at least one team can't attack each other. A character can be on more than one team if you just separate them by commas, for example <code>team1, team2, team3</code>
|}

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

Rain Weather Effects

2018-03-08T21:41:03Z

Mng: Added to category: Modding, Overgrowth

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

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

2018-03-08T19:42:49Z

Mng: /* no_grab */ Added Link to Prefabs

:''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?

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

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

Configuring Overgrowth

2018-03-08T19:33:30Z

Mng: /* Editor Hotkeys */ Added link to Prefabs

You can edit most settings by pressing the Settings button on the main menu or on the pause menu. There are even more settings available from the "Settings" top menu bar on the main menu.

If you need to edit the config without starting the game, you can change your configuration by modifying your '''config.txt'''. Just below you can see the location of this file on each operating system.

There is also a community made tool available for editing the config file without starting the game, the [http://forums.wolfire.com/viewtopic.php?f=13&t=14201 SUMLauncher].

==Config File Location==

The configuration file is created when Overgrowth is started for the first time.

To view or edit your config file, find your operating system in the list below and follow the shown path.

'''Windows'''

<code>My Documents\Wolfire\Overgrowth\Data\config.txt</code>

''Note:'' NOT Program Files\Wolfire\Overgrowth\Data!

'''Mac'''

<code>Macintosh HD/Users/~/Library/Application Support/Overgrowth/Data/config.txt</code>

where ~ is your username.

''Note:'' If you are using Lion, your library folder is hidden by default... in the finder, click the "Go" menu, then Press Option, and Library will appear in the list.

'''Linux'''

<code>~/.local/share/Overgrowth/Data/config.txt</code>

==Settings==

===General Settings===
{| class="wikitable"
|-
! Setting !! Default Value !! Description
|-
! screenwidth
| 800 || The game's horizontal resolution.
|-
! screenheight
| 600 || The game's vertical resolution.
|-
! fullscreen
| false || Determines whether to run in full screen or windowed mode.
|-
! vsync
| false || Limits the framerate to match the user's monitor refresh rate (smooths out the framerate).
|-
! simple_shadows
| 1 || Disables dynamic shadows if set to 1.
|-
! blood
|1 || Disable or enable blood
|-
! blood_color
| 0.4 0 0 || The color of blood in the game in R, G, B. Each value should be between 0 and 1.
|-
! multisample
| 0 || Determines the level of anti-aliasing (smooths out jagged edges). Should be 1, 2, 4 or 8.
|-
! anisotropy
| 0 || Determines the level of anisotropic filtering (increases the quality of textures drawn far away and at an angle). Should be 1, 2, 4 or 8.
|-
! motion_blur_amount
| 0 || How much motion blur to apply, should be between 0 and 1.
|-
! post_effects
| true || Determines whether to use post effects.
|-
! shaders
| true || Determines whether to use shaders.
|-
! texture_reduce
| 0 || Determines the level to which the texture resolutions should be reduced (higher numbers means lower resolution).
|-
! texture_minimize_ram
| 1 || '''TODO: What does this do?'''
|-
! full_level_unload
| true || '''TODO: What does this do?'''
|-
! gamma_correct
| true || Determines whether to use gamma correction.
|-
! fps_label
| false || Determines whether to display the current fps (frames per second) on screen.
|-
! sound_label
| false || Determines whether to display all active sounds on screen.
|-
! visible_raycasts
| false || Determines whether to display lines representing all AIs' visibility.
|-
! visible_sound_spheres
| false || Determines whether to display spheres representing the distance sounds travel (such as running).
|-
! editor_mode
| false || Determines whether to start the game in play mode (false) or editor mode (true).
|-
! invert_y_mouse_look
| false || Determines whether to invert the y-axis controls (looking up/down).
|-
! use_raw_input
| true || Use raw mouse input, solves mouse issues for some people.
|-
! invert_y_gamepad_look
| false || Determines whether to invert the y-axis controls (looking up/down).
|-
! tet_mesh_lighting
| 0 || If set to 1, use the pre-baked tetrahedral mesh global illumination. '''TODO: Does this work?'''
|-
! light_volume_lighting
| false || Use ambient light volume lighting if available.
|-
! global_time_scale_mult
| 1.0 || How fast the game should run. Can be set to above and below the min./max. values of the ingame settings. '''TODO: Hardcoded min/max values?'''
|-
! game_difficulty
| 1.0 || How hard the game should be, higher is harder.
|-
! tutorials
| true || Helpful messages are displayed in the game.
|-
! difficulty_set
| false || '''TODO: What does this do?'''
|-
! volume_shadows
| false || Use experimental volume shadow graphics tech.
|-
! ssao
| false || Use experimental screen space ambient occlusion graphics tech.
|-
! auto_ledge_grab
| true || The player character will automatically grab ledges when they can. If false you need to hold right click to grab ledges.
|-
! particle_field
| true || Show particle fields in the game. '''TODO: Does this affect CPU particle fields, GPU particle fields, or both?'''
|-
! custom_level_shaders
| true || Use shaders made for specific levels to add things like snow, wetness near water etc.
|-
! disable_fog
| false || Disables atmoshperic fog.
|-
! simple_fog
| false || Extra simple fog calculations for low-end graphics cards.
|-
! no_auto_nav_mesh
| false || Disables automatic nav mesh generation. '''TODO: Verify that this is what it does'''
|-
! no_texture_convert
| false || Skip converting textures to .dds format to save VRAM. '''TODO: Verify that this is what it does'''
|-
! gl_load_s3tc
| true || '''TODO: What does this do?'''
|-
! skip_loading_pause
| false || You don't have to press left click to start the level after it has been loaded.
|-
! brightness
| 1 || Increase or decrease the brightness of the game.
|-
! use_soundtrack_limiter
| true || Better handling of music volume when transitioning between tracks.
|-
! master_volume
| 0.8 || Overall loudness of all game audio.
|-
! music_volume
| 0.4 || Loudness of game music.
|-
! media_mode
| false || Determines whether to disable the in-game interface.
|-
! baked_shadows
| true || (Deprecated) Determines whether to use the pre-baked shadows (true) or cascaded shadow maps (false).
|-
! debug_key_presses
| false || '''TODO: What does this do? How are key presses debugged when this is on?'''
|-
! block_cheating_progress
| true || Disables unlocking levels when cheats are active, like when in the editor.
|-
! auto_camera
| false || Determines whether to have the camera automatically return to a position behind the player. Only affects the player controlled with keyboard and mouse in local multiplayer with splitscreen, will be true for the other players.
|-
! split_screen
| false || Determines if the game view should be split or not when there is more than one player.
|-
! chase_camera_fov
| 90.0 || The field of view of the camera when playing the game.
|-
! editor_camera_fov
| 90.0 || The default field of view of the camera when in the editor.
|-
! report_case_errors
| false || Reports capitalization errors in the log when they are found. '''TODO: Does this work?'''
|-
! background_process_pool
| false || Use background processes for things like calculating the nav mesh. '''TODO: Is this accurate?'''
|-
! main_menu
| true || Show main menu when starting the game. If false it will load the level at the path in the debug_load_level setting.
|-
! debug_load_level
| Project60/16_red_desert.xml || If main_menu is set to false, the level at this path will load when the game is started.
|-
! mouse_sensitivity
| 0.5 || Determines how far the camera in the game rotates when the mouse moves.
|-
! gpu_skinning
| false || Use the graphics card to skin characters. This should be false to avoid any issues.
|-
! detail_objects
| 1 || Determines if 3D grass models, small rocks etc. are displayed on the terrain.
|-
! seamless_cubemaps
| true || Make cubemaps display seamlessly. '''TODO: When is this useful?'''
|-
! debug_keys
| true || Enables use of debug keys, such as F for laser eyes. '''TODO: Does this still work?'''
|-
! shader_dir_path
| Data/GLSL/ || Where the game looks for shaders. '''TODO: Does this work?'''
|-
! debug_show_ai_state
| false || '''TODO: What does this do?'''
|-
! debug_show_ai_path
| false || Show lines to every NPC's destination.
|-
! debug_draw_window
| false || Show debug window in the top left.
|-
! albedo_only
| false || Display only color of objects, without any lighting etc.
|-
! no_decals
| false || Disable rendering of decals.
|-
! single_pass_shadow_cascade
| false || Render all real-time shadows in a single pass. '''TODO: Does this still work?'''
|-
! shader_debug
| false || '''TODO: What does this do?'''
|-
! opengl_callback_errors
| true || '''TODO: What does this do?'''
|-
! opengl_callback_error_dialog
| false || '''TODO: What does this do?'''
|-
! occlusion_query
| true || '''TODO: What does this do?'''
|-
! dump_include_scripts
| false || '''TODO: What does this do?'''
|-
! allow_game_dir_save
| false || If true, the editor encourages you to save in the working directory instead of the game directory.
|-
! level_backup_count
| 10 || The maximum number of backups to save for each level. Backups can be found in working_dir/Overgrowth/Data/Levels/backups/.
|-
! no_reflection_capture
| 0 || If set to 1, all reflections are disabled.
|-
! has_detected_settings
| false || '''TODO: What does this do?'''
|-
! save_as_crunch
| false || Use the crunch library to convert textures. '''TODO: Does this do anything?'''
|-
! check_for_workshop_membership
| true || '''TODO: What does this do?'''
|-
! enable_live_update
| true || Enables automatic texture and script reloading when a change is detected.
|-
! level_load_stress
| false || '''TODO: What does this do?'''
|-
! detail_object_decals
| 1 || Apply decals to detail objects such as grass, small rocks etc.
|-
! asdebugger_enabled
| 0 || Activate the AngelScript debugger. '''TODO: What does this do more exactly?'''
|-
! asdebugger_break_on_script_change
| 0 || '''TODO: What does this do?'''
|-
! menu_show_asdebugger_contexts
| 0 || '''TODO: What does this do?'''
|-
! extra_data_path
| || Path to a directory containing a second Data folder that you want the game to use.
|}

===Keyboard and Mouse===
{| class="wikitable"
|-
! key[quit]
| esc || Exits from player mode into editor mode, and opens a menu allowing the user to return to the main menu.
|-
! key[slow]
| tab || Toggles slow motion.
|-
! key[fast]
| \ || '''TODO: Does this do anything?'''
|-
! key[crouch]
| lshift || Causes the player to crouch.
|-
! key[jump]
| space || Causes the player to jump.
|-
! key[show_timing]
| f2 || '''TODO: What does this do?'''
|-
! key[screenshot]
| f7 || Captures a screenshot (saved in ''/Data/Screenshots/'')
|-
! key[transparent_screenshot]
| f8 || Captures a screenshot in .png format where the sky and terrain is transparent.
|-
! key[console]
| ` || Deprecated, it pauses the game. But that doesn't have anything to do with the console.
|-
! key[left]
| a || Causes the player to move to the left.
|-
! key[right]
| d || Causes the player to move to the right.
|-
! key[up]
| w || Causes the player to move forward.
|-
! key[down]
| s || Causes the player to move backward.
|-
! key[item]
| e || Causes the player to sheathe or unsheathe a weapon.
|-
! key[drop]
| q || Causes the player to pick up a weapon. Holding left shift, looking down and pressing Q drops the held weapon.
|-
! key[skip_dialogue]
| return || Skips the currently active dialogue.
|-
! key[rclick]
| rshift || Alternate key used for "right clicking".
|}

=== Xbox controller ===
{| class="wikitable"
|-
! xbox_look_sensitivity
| 1.5 || Supposed to be the sensitivity of an attached Xbox controller, however it does nothing.
|-
! xbox[lookx]
| R_STICK_X || Xbox axis mapped for looking along the x-axis.
|-
! xbox[looky]
| R_STICK_Y || Xbox axis mapped for looking along the y-axis.
|-
! xbox[movex]
| R_STICK_X || Xbox axis mapped for movement along the x-axis.
|-
! xbox[movey]
| R_STICK_Y || Xbox axis mapped for movement along the y-axis.
|-
! xbox[jump]
| RB || Xbox jump button.
|-
! xbox[crouch]
| LB || Xbox crouch button.
|-
! xbox[attack]
| RT || Xbox attack button.
|-
! xbox[grab]
| LT || Xbox grab button.
|-
! xbox[item]
| A || Xbox item button.
|-
! xbox[drop]
| X || Xbox drop button.
|-
! xbox[skip_dialogue]
| START || Xbox skip currently acive dialogue.
|-
! xbox[quit]
| BACK || Xbox bring up menu or go back in menu.
|}

===Generic Controller===
{| class="wikitable"
|-
! controller[movex]
| axis1 || Controller axis mapped for movement along the x-axis.
|-
! controller[movey]
| axis2 || Controller axis mapped for movement along the y-axis.
|-
! controller[lookx]
| axis3 || Controller axis mapped for looking along the x-axis.
|-
! controller[looky]
| axis4 || Controller axis mapped for looking along the y-axis.
|-
! controller[jump]
| button11 || Controller jump button.
|-
! controller[crouch]
| button10 || Controller crouch button.
|-
! controller[item]
| button1 || Controller item button.
|-
! controller[drop]
| button3 || Controller drop button.
|-
! controller[attack]
| axis6>0.5 || Controller attack "button" (default mapping is set to an axis being less than half full in a negative direction).
|-
! controller[grab]
| axis5>0.5 || Controller grab "button" (default mapping is set to an axis being greater than half full in a positive direction).
|}

===Editor Hotkeys===

These keys only work when the editor is active. To activate the editor, press F1 when any level is loaded.

For more in-depth information on how to use the editor, read the [[Editor Interface]] article.

{| class="wikitable"
|-
! bind[pause]
| ` || Toggles freezing the time.
|-
! bind_win[quit]
| alt+f4 || Turns off the game.
|-
! bind_unix[quit]
| cmd+q || Turns off the game on Linux.
|-
! bind[back]
| esc || Opens or closes the menu, goes back in menu if it can.
|-
! bind[clone_transform]
| alt || Hold to clone an object when you transform (move, rotate or scale) it.
|-
! bind[snap_transform]
| ctrl || Hold to snap transformations to certain increments.
|-
! bind[force_rotate]
| r || Hold to activate the rotate tool.
|-
! bind[force_scale]
| e || Hold to activate the scale tool.
|-
! bind[force_translate]
| t || Hold to activate the move tool.
|-
! bind[normal_transform]
| shift || Hold to rotate/scale/translate on alternate axies.
|-
! bind[edit_script_params]
| u || Toggles showing the ''Selected'' window.
|-
! bind[single_selected]
| i || Toggles showing the ''Single Selected'' window.
|-
! bind[edit_color]
| cmd+p || Toggles the ''Color Picker'' window.
|-
! bind[search_scenegraph]
| cmd+f || Opens the ''Scenegraph'' window and focuses its search field.
|-
! bind[scenegraph]
| y || Opens the ''Scenegraph'' window.
|-
! bind[toggle_player]
| cmd+shift+p || Toggles whether the selected spawn points are player controlled or NPCs.
|-
! bind[toggle_object_editing]
| cmd+1 || Toggles whether you can edit static meshes.
|-
! bind[toggle_decal_editing]
| cmd+2 || Toggles whether you can edit decals.
|-
! bind[toggle_hotspot_editing]
| cmd+3 || Toggles whether you can edit gameplay objects.
|-
! bind[open_spawner]
| cmd+l || Deprecated, does nothing.
|-
! bind[save_level]
| cmd+s || Saves the level.
|-
! bind[save_selected_items]
| cmd+shift+s || Saves the selected items as a [[Prefabs|prefab]].
|-
! bind[cut]
| cmd+x || Saves the selected objects to the clipboard and then removes them.
|-
! bind[paste]
| cmd+v || Pastes whatever objects are in the clipboard on the mouse location.
|-
! bind[copy]
| cmd+c || Saves the selected objects to the clipboard.
|-
! bind[undo]
| cmd+z || Reverts the most recent edit.
|-
! bind[redo]
| cmd+shift+z || Reverts the most recently undo.
|-
! bind[enable_imposter]
| cmd+i || Deprecated, does nothing. '''TODO: Is this accurate?'''
|-
! bind[disable_imposter]
| cmd+shift+i || Deprecated, does nothing. '''TODO: Is this accurate?'''
|-
! bind[connect]
| alt || Hold and left click to connect the selected object to the clicked object. Is used for ''nav connection'' hotspots, ''Path Point'' hotspots, weapons etc.
|-
! bind[disconnect]
| shift+alt || Hold and left click to break an existing connection between the selected object and the clicked object.
|-
! bind[group]
| cmd+g || Groups the selected objects.
|-
! bind[ungroup]
| cmd+shift+g || Ungroups the selected group.
|-
! bind[box_select]
| b || Hold and left click and drag to create a selection box. When you release left click, all objects in the box are selected.
|-
! bind[deselect_all]
| q || Deselects any selected objects.
|-
! bind[select_all]
| cmd+a || Select all objects in the level.
|-
! bind[select_similar]
| cmd+shift+a || Select all objects that are similar to the selected object.
|-
! bind[add_to_selection]
| shift || Hold while selecting objects to add them to the selection.
|-
! bind[bake_gi]
| cmd+j || Deprecated, does nothing.
|-
! bind[kill_selected]
| cmd+k || Kill the selected character and instantly save its ragdoll position. Press the button combination again once the character has fallen to save the resting pose.
|-
! bind[print_objects]
| f11 || Print the selected objects to the log. '''TODO: Is this accurate?'''
|-
! bind[toggle_level_load_stress]
| f10 || '''TODO: Is this used? Maybe used in conjunction with the ''level_load_stress'' config setting?'''
|-
! bind[new_level]
| cmd+n || Does nothing.
|-
! bind[open_level]
| cmd+o || Does nothing.
|-
! bind[frame_selected]
| f || Frames the selected object so it's visible in the camera. Hold this button and rotate the camera to orbit around the object.
|-
! bind[frame_selected_force]
| shift+f || Same as frame_selected, but puts the camera closer.
|-
! bind[refresh]
| f5 || '''TODO: What does this do?'''
|}

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

==Controller Setup==

Most common controllers should work out of the box for Overgrowth. The control scheme is different from most games, but works well for Overgrowth's gameplay. If you want to change the controls you need to edit the config file. First make sure the game is turned off. Then find and open your [[#Config_File_Location|config file]], then edit the bindings in that file for [[#Xbox_controller|Xbox controller]] if you use that, otherwise [[#Generic_Controller|generic controller]].

After making your desired changes, save the file and open the game.

If you have problems with your controller on Mac, check out [http://forums.wolfire.com/viewtopic.php?f=13&t=12631 Anton's guide].

===Advanced Controller Setup===

If for some reason your controller isn't working properly with the game, here are some instructions for Windows 7 that might help you out:

First, make sure your controller is plugged in to your computer.

Next, open the start menu and click on ''Control Panel'' (located on the right side). Once opened, make sure the view is set to ''Large Icons'' (switchable in the upper right corner). Select ''Devices and Printers''.

You should see your controller listed under ''Devices''. Right click it, and select ''Game Controller Settings''. The ''Game Controllers'' window will appear. Make sure your controller is selected, then click on ''Properties''.

Once again, a new window should appear - make sure that the view is set to the ''Test'' tab. In this view, you will be able to determine which physical button is mapped to each virtual button. Play around with your controller to confirm that everything is working properly, and take note of the button mappings.

Now navigate to and open up your '''config.txt''' file (as described above). Rearrange the mappings in the file to match your desired controller setup.

Once you have everything modified, save the '''config.txt''' file and launch Overgrowth in order to test the new configuration.

If you just pre-ordered overgrowth, read this first

2018-03-08T18:15:20Z

Mng: Fixed double redirect

#REDIRECT[[Overgrowth FAQ]]

Lore

2018-03-08T18:10:29Z

Mng: Added to category: Lore

=Lore of Lugaru=

This page is for all ideas or stories regarding the lore of Lugaru Island and surrounding islands (i.e The Wolves island before they invaded Lugaru). Feel free to add stories, myths, legends and any ideas.

All the stories on this page are Fanmade, and are not necessarily canon.

===Stories===

The stories of each race will mainly provide small snippets of backstory from around the time of the events in Lugaru. Most will not involve Turner or other main characters but will instead focus on the inhabitants of Lugaru and it's surrounding islands.

====The Story of Jounquil Terbouchet====

(This first story is just to give an idea of what a story should be like, it's not supposed to be anything special)

Not so many moons ago, on an island to the south of Lugaru, there lived a young rabbit called Jounquil Terbouchet. Jounquil was a simple rabbit, a farmer with a modest cottage and crops. Jounquil sold his crops to other rabbits, and sometimes dogs, at the local market. He made a decent living and was well known and respected all over his island.

One day, while tending his crops Jounquil was approached by a young rabbit who had been watching him for some time. Jounquil straightened up, using his hoe for support. The young rabbit introduced himself as Javern, a representative of King Hickkory of Lugaru. He asked Jounquil how long he had been running his farm, Jounquil told him that it was the family farm, passed down to him from his father, and his father before him. Javern asked him how much money he made when he sold his produce. Although Jounquil thought this young rabbit was acting a bit strange, he told him that he made enough. Javern repeated his question, this time asking for the exact amount. Finding the young rabbit extremely rude, Jounquil raised his hoe to Javern, telling the rabbit to state his true purpose. Javern stepped back, warning Jounquil that he wa making a mistake. With this, Jounquil lost his temper, striking out at Javern.

Javern, sensing that Jounquil was not the country simpleton he appeared to be, backed off. He gave Jounquil one more warning, before leaving his farm.

Jounquil ended up traveling to Lugaru and becoming a raider. He never encountered Turner but he joined the Guards at Rock Hall after Fiver took control. He served Fiver well, fighting in several battles with the wolves. He retired from Guardship at the age of 57, settling down in a small settlement near a dead volcano

====Fendalin the Defender====

Fenadlin was a Rabbit warrior from one of Lugaru's neighboring islands, [[Vatoor]] (Lugaru and Vatoor are both part of the [[Mannow]] islands), and is known for his gallant death while fighting the legendary general [[Ansandi]].

Fendalin grew up near the city-state of Vieren, where constant political tension between [[Vieren]] and the surrounding island government of Vatoor led to most towns losing the majority of its males as conscripts for whichever government controlled it. Fendalin was to be conscripted for the Vierenese, but he succeeded in running away at a young age and becoming a volunteer for Vatoor. He grew as a warrior during this time, which came at the cost of killing many of his Vierenese friends in battle, including his brother. Eventually his superiors recommended him for a special program, the [[Suteran]], and he became a member of this force of joined warriors from various Mannow islands. He may have had interactions with the fighter known as Turner while a member of the Suteran.

Many of the missions which Fendalin was assigned during his life were classified and never revealed.

The mission for which Fendalin is known was his last, and took place during "The War In Which Mannow Fell," also known simply as the "[[Mannow War]]," which took place between the forces of a magician named [[Chaar]], and the unified governments and armies of the Mannow islands. Fendalin was given by the Suteran a small group of skilled warriors under his command who were to assasinate a Cat named Ansandi, who was one of Chaar's generals, and who was a member of the [[Assasins of the Bright Tapestry]], and who is considered one of the greatest fighters and strategists to have ever lived. During this misison, Fendalin's group were killed and Fendalin was forced to face Ansandi alone, managing to wound Ansandi three times before being killed.

Fendalin's near-success put him in the history books as one of the greatest warriors ever, and a hero of the Mannow islands. Unfortunately, Chaar's forces eventually conquered most of the Mannow islands, although Chaar commanded his forces to stay away from one of the sacred temples in Lugaru, known as [[Krypa]], possibly at Ansandi's request and the temple's connection to the cat deity, The Sphinx.

===Myths===

Myths will be ancient stories that revolve around a particular person or event, but not necessarily real ones. Myths will be the most common form of story, and be the most freely written. You can write about whatever you want, but nothing too rude, and nothing offensive.

====The Myth of the Whale-Man====

If you ask any regular sailor if they believed in the Whale-man, they'd obviously reply "No", laugh nervously, and go about their business. That is because any sailor that does completely believe in the Whale-man, is not a sailor anymore due to their intense fear of the ocean, and has moved far inland due to their Thalassophobia. The rumors and theories regarding the Whale-man's intentions and origin vary greatly depending on which paranoid pedestrian you parley with over a pint, but one common theme amongst every speculation is that he is brutal, unforgiving, and craves destruction for one reason, or another.

Some believe the Whale-man is a religious figure, once worshiped by a cult as the god of the sea, but after some mysterious incident, the cult disappeared. The Whale-man now seeks revenge for the loss of his subjects and demands tribute from all lowly mortals for their crimes against him. He assaults ships for the fear and respect he deserves, and lives off of the agony of the infidels.

Others believe that the Whale-man was born under a group of whales, but had the hideous deformation of arms and legs, and that he was cast away due to his grotesque appearance. The then Whale-boy never knew right from wrong, and out of its probably teenage whale-angst began to attack both whales and denizens of Lugaru alike. Anything that was large and floated in the water reminded him of his kind that had betrayed him over his appearance, and in strife, would lash out against it with his blubbery flubbery whale arms, trying to break it in two and eat the remains.

An interesting possibility is that the Whale-man is the next step in, what many feline biologists call: Whale-volution. The whale species would benefit greatly from the addition of limbs, and perhaps if the Whale-man has offspring, he could easily conquer Lugaru. Although this is a very wild conclusion to reach, it has struck fear into the hearts of many people, and there have been cases of hunting parties hired by cats for ludicrous sums of money to kill the Whale-man before he can breed with a Whale-woman. One such party was headed by a rabbit named Retsae, but that's another story for another time.

In the end, it's all just rumors, theories, and speculation. There's no hard evidence any ships were lost because of a whale-like individual. The people of Lugaru can be quite split on the subject of the Whale-man's existence. There was one such instance of this when two drunkards began a debate about the Whale-man, which escalated into a fist fight about the Whale-man, which escalated into a town wide riot about the Whale-man, which escalated into a full scale clan war, all because of the Whale-man. In the end, no matter which side you choose, the prospect of a gargantuan, whale-like being lurking in the depths of the ocean should send a chill up your spine. Unless you were Retsae, but Retsae was totally bonkers.

===Legends===

Legends will be sort of a cross between stories and myths. They revolve around real people, the person can be unbelievably powerful or strong or charming or anything, but Legends will have an element o truth to them.

====The Legend of Retsae====

If you've heard of the Whale-man, and have spoke about the Whale-man while rabbits are present, there is a large chance that you will be told the story of Retsae, whether you want to hear it or not. Retsae is revered as a legend among many rabbits, and regarded as a villain among most cats. Many variations of her story have been told to me throughout time, but for your sake I'll tell either the most interesting or the most plausible versions of her narrative.

Retsae was born on the cliffs of Lugaru, her mother facing the oceans, and her father facing the land. Rabbits say she was launched out of the womb like an arrow from a bow, but cats say she merely was dropped by her possibly inebriated parents into the cold, blue depths below. Either way you see it, she was an excellent swimmer from birth onward, and managed to swim to a nearby dock before her pink body was scooped up by fisherman.

Retsae grew up to be (in rabbit standards) a beautiful young lady, who had a tender heart, but was often very somber and preferred the crashing and sloshing of the ocean to the pipping and chipping of her rabbit brethren. She was loved by many of the burrow-members but spent most of her time outside of the burrow, swimming in the deep blue sea to relax after a days work. She was given many gifts by male members of the burrow, and given many cold shoulders by female members of the burrow, which resulted in her feeling isolated in her own community. She ran away from home at her prime in rabbit standards, and half of the burrow followed her trail and vowed allegiance to her. Without her consent, she began leading a crew of devoted, and probably sexually frustrated male rabbits across Lugaru in search of a place she could ditch them without leaving them to die.

One day she came across a settlement of cats who were desperately hiring hunters of any background to go after a mythological creature of the sea, and Retsae, sensing her crew's hunger to prove themselves to her, took the bounty, was rewarded with a ship, and was promised much more money in the process after they came back with significant evidence they had killed the creature that was known as the Whale-man. The ship wasn't actually made to hold all of the rabbits, but they clambered onto it nonetheless. Retsae then steered the ship towards the direction of the burrow from whence they all came, and unbeknownst to her crew, planned to abandon ship before they hit the cliff that the crew didn't even know they were headed to.

Although her plan was to return everyone safely, it was not as simple as pointing a ship in one direction and snoozing till you hit some rocks. They almost immediately were confronted by a storm of epic proportions, and lightning struck the stem of the ship, lighting many rabbits on fire, which jumped into the ocean. Only a few were pulled back from the murky deep. The crew suffered many hardships on their journey, but there was one hardship in particular, that made Retsae both famous and infamous.

After encountering a band of pirates, what was left of crew had pretty much given up hope on survival, and blamed Retsae. She was overcome with tremendous guilt. She walked to the larboard side, saluted her crew, and stabbed herself with a knife. As the crew screamed in despair at losing what made them even made them leave their homes in the first place, she fell into the waters below. A couple decided to jump in after her, and were forever regarded as "lucky", because at the moment the last one of her most devout followers jumped in, the Whale-man had risen from the sea, and belly flopped onto the ship. The crew who had dived down were thrown under the currents from the tidal wave of the ships destruction.

Retsae, and a select few others awoke inside a squishy wet structure, at first thinking themselves to be in a smelly purgatory. They then realized that they were in the mouth of the Whale-man. They began screaming. Retsae calmed them, and asked to speak to the Whale-man. He moaned a deep whale-y moan in agreement. He opened his jaws and released only Retsae from his mouth. She looked straight into the creature's eyes and asked "What do you want?" as elegantly and smoothly as she always had spoken.

The next portion of this legend is almost always spoken in an embarrassed tone, and I'll spare you the....details. In fact, the first time I heard this story I got spared the details and it only got clarified at the end of the story where she goes around laying eggs. Do you get where I'm going with this?

Well, whatever happens with the ocean, shall stay with the ocean. I fear for the terrified young rabbits who were trapped inside the whale. What did they hear that entire time? How does something like that even ''happen?'' It makes me shudder every time I think about it. I-I mean not to say I think about it often it's just that-...whatever, never mind.

Back...back to the story. So the Retsae and her crew members were all set free and they headed back home. After arriving, she told everyone of her travels, and promised to exile herself as punishment. Retsae, still feeling quite guilty, gave gifts to every family that had a member leave the burrow in pursuit of her. The gifts varied from money to sweet foods, and by the end Retsae had nothing to herself. She left her burrow along the coastline and vowed not only to never look at the ocean again, but to never be seen by anyone ever so that she would not accidentally lure them into their deaths, and to give back to her species as best she could. She vowed that she would raise the young whale-rabbit-things she had as land creatures, and make sure they were never tainted by the evil of their father. She promised to raise them to be friendly with all rabbit-kind, so that both species may live in harmony.

She traveled the land laying eggs. Retsae Eggs, they were called. If you found one, it was rumored to be extreme good luck, and if you even did find it, you would swear secrecy and forget all about its existence, promising never to tell another soul of its place.

The legend of Retsae is both illogical and disturbing in some areas, depending on how open minded or drunk the teller of the story is. It's a wonder that it's even believed to be a legend told to young rabbits considering it can be very unflattering to female company. The Retsae Eggs have never been located (and the story covers this up quite nicely), but there have been rumors from some skeptics that the eggs could be merely painted rocks. All in all, it's an interesting story, but just don't tell it if you want to impress a lady with your knowledge of rabbit tradition and lore, because as I have found out, it can get you a couple bad looks, and even a swift punch in the face depending on how graphic you tell the Whale-man part.

[[Category: Lore]]

If you just pre-ordered overgrowth, read this first

2018-03-08T18:07:47Z

Mng: Added redirect to Overgrowth Alpha FAQ; removed text: Merged with Overgrowth Alpha FAQ

#REDIRECT[[Overgrowth Alpha FAQ]]