TiMan: Add a sourced SOMA guide with explanations and stock-script examples.

2026-10-02T12:13:01Z

Add a sourced SOMA guide with explanations and stock-script examples.

New page

{{shortPageTitle}}

The Game Over Handler controls the death screen and checkpoint restart. GameOver_Start supplies the death source, and GameOver_SetCustomGameOverScreenText selects the localized text displayed before reloading the checkpoint.

== Before you start ==
# Open the map script inside your own mod. Keep its generated includes, <code>cScrMap : iScrMap</code> class and callback structure. See [[HPL3/SOMA/Getting Started/Add Your First Script|Add your first script]] if you have not edited a map script yet.
# Add the helper include shown below alongside the script’s other includes.
# Read the stock example before copying its calls: named entities, voice subjects, materials and callbacks must belong to the map or resources you are using.

== Follow the stock example ==
<syntaxhighlight lang="cpp">
#include "helpers/helper_modules.hps"
</syntaxhighlight>

=== GameOver_Start ===
Starts the Game Over screen

In <code>script/player/Player.hps</code>, SOMA calls <code>GameOver_Start</code> as follows.

<syntaxhighlight lang="cpp">
GameOver_Start(asSource);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>asDeathSource</code> || <code>asSource</code>
|}

This is an excerpt from that stock script; its referenced names and variables belong to that script.

=== GameOver_SetCustomGameOverScreenText ===
Sets the message that will be displayed before a checkpoint is loaded (after proper death):

== Check your change ==
Save the script and restart the map in development mode with <code>F5</code>. If the script fails, open <code>F1</code> and use '''Show Error List''' or '''Show HPL Log'''. See [[HPL3/SOMA/Getting Started/Test Debug and Continue|the development loop]] for the launch and debugging steps.

== See also ==
* [[HPL3/Scripting/User Modules Overview|User modules]]
* [[HPL3/SOMA/Scripting/Modules Helper|SOMA module helpers]]

[[Category:English]]

HPL3/SOMA/Scripting/Game Over Handler - Revision history

TiMan: Add a sourced SOMA guide with explanations and stock-script examples.