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

2026-10-02T12:12:05Z

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

New page

{{shortPageTitle}}
{{stub}}

The Datamine Handler stores datamine sources and runs a page-based interaction containing voice subjects, localized text and images. Its _Global_BeginDatamining reads the source entity, final-subject and completion callbacks, range area, voice-stop switch and page data from global arguments.

The included custom_depth/util_datamine.hps utility fills those arguments before calling _Global_BeginDatamining. Its Init reads up to six sets of Page_N_VoiceSubject, Page_N_TextCategory, Page_N_TextEntry and Page_N_Image variables. This utility is documented here as source evidence; its use in the shipped campaign has not been established.

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

=== Player_StopDatamining ===

In <code>script/modules/AttackMeterHandler.hps</code>, SOMA calls <code>Player_StopDatamining</code> as follows.

<syntaxhighlight lang="cpp">
Player_StopDatamining();
</syntaxhighlight>

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.

== Still to expand ==
The included custom_depth utility demonstrates the argument layout, but its use in the shipped campaign has not been established. A current, complete datamine-entity setup is still needed.

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

[[Category:English]]

HPL3/SOMA/Scripting/Datamine Handler - Revision history

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