Datamine Handler

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

1. Open the map script inside your own mod. Keep its generated includes, cScrMap : iScrMap class and callback structure. See Add your first script if you have not edited a map script yet.
2. Add the helper include shown below alongside the script’s other includes.
3. 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

#include "helpers/helper_player.hps"

Player_StopDatamining

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

Player_StopDatamining();

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 F5. If the script fails, open F1 and use Show Error List or Show HPL Log. See 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

• User modules
• SOMA module helpers