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

2026-10-02T12:13:33Z

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

New page

{{shortPageTitle}}

The Menu Handler controls main-menu and pause-menu presentation. PauseMenu_Enabled allows or prevents use of the pause menu; PauseMenu_Show changes whether it is shown, and MainMenu_SetBGPhase selects a main-menu background phase.

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

=== PauseMenu_Enabled ===
Sets if the pause menu is allowed to be used

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>abActive</code> || If true, the pause menu can be opened
|}

In <code>maps/main_menu/main_menu.hps</code>, SOMA calls <code>PauseMenu_Enabled</code> as follows.

<syntaxhighlight lang="cpp">
PauseMenu_Enabled(false);
</syntaxhighlight>

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

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

=== PauseMenu_Show ===
Show the pause manu

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>abActive</code> || If true, the pause menu can be opened
|}

In <code>maps/_e3/_e3_01_02/_e3_01_02.hps</code>, SOMA calls <code>PauseMenu_Show</code> as follows.

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

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

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

=== MainMenu_SetBGPhase ===
Change main menu BG state

In <code>maps/chapter05/05_02_ARK_inside/05_02_ARK_inside.hps</code>, SOMA calls <code>MainMenu_SetBGPhase</code> as follows.

<syntaxhighlight lang="cpp">
MainMenu_SetBGPhase(eMainMenuPhase_AfterEnd);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>aPhase</code> || <code>eMainMenuPhase_AfterEnd</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.

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

[[Category:English]]

HPL3/SOMA/Scripting/Menu Handler - Revision history

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