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

2026-10-02T12:13:29Z

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

New page

{{shortPageTitle}}

The Wake Handler controls falling asleep immediately and waking up over time. Wake_SetAsleep sends the asleep flag to the module; Wake_StartWakeup sends the desired wakeup time.

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

=== Wake_SetAsleep ===
Puts the player instantly to sleep (or awake)

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>abAsleep</code> || if true then the player is asleep, if false then awake
|}

In <code>maps/chapter04/04_01_tau_outside/04_01_tau_outside.hps</code>, SOMA calls <code>Wake_SetAsleep</code> as follows.

<syntaxhighlight lang="cpp">
Wake_SetAsleep(true);
</syntaxhighlight>

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

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

=== Wake_StartWakeup ===
Wakes up the player.

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>afTime</code> || time to take to wake up.
|}

In <code>maps/chapter04/04_01_tau_outside/04_01_tau_outside.hps</code>, SOMA calls <code>Wake_StartWakeup</code> as follows.

<syntaxhighlight lang="cpp">
Wake_StartWakeup(5.0f);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>afTime</code> || <code>5.0f</code>
|}

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

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

== Read the example ==
In the Tau Outside sequence, <code>Wake_SetAsleep(true)</code> selects the asleep state and its GUI draws a black background. Later, <code>Wake_StartWakeup(5.0f)</code> enters the waking-up state for five seconds and starts an image-trail effect for that interval. The duration is accumulated from the GUI time step.

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

[[Category:English]]

HPL3/SOMA/Scripting/Wake Handler - Revision history

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