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

2026-10-02T12:21:31Z

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

New page

{{shortPageTitle}}

The SOMA script declarations for this interface reference are in <code>script/interfaces/AchievementHandler_Interface.hps</code>.

The Achievement Handler creates and registers the game’s achievement records. Map scripts call Achievement_Unlock with an eAchievement value; the game helper forwards that value to UnlockAchievement on the native handler.

== 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_game.hps"
</syntaxhighlight>

=== Achievement_Unlock ===

In <code>maps/chapter03/03_01_omicron_outside/03_01_omicron_outside.hps</code>, SOMA calls <code>Achievement_Unlock</code> as follows.

<syntaxhighlight lang="cpp">
Achievement_Unlock(eAchievement_Dream);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>alID</code> || <code>eAchievement_Dream</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/SOMA/Scripting|SOMA scripting]]

[[Category:English]]

HPL3/SOMA/Scripting/Achievement Handler - Revision history

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