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

2026-10-02T12:13:37Z

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

New page

{{shortPageTitle}}

The Infection Handler draws growing infection trees at screen borders. Border indices select top, bottom, left or right, and ClearTrees removes the generated trees.

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

=== Infection_CreateBorderTree ===
Creates an infection tree at a border of the screen

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>alBorder</code> || The border of the screen where it randomly appears 0=top, 1= bottom, 2=left, 3=right
|-
| <code>afOffset</code> || How much outside of the screen the tree start is offset
|-
| <code>avSize</code> || The size of the start tree segment.
|-
| <code>afSpeed</code> || The speed at which the tree grows.
|}

In <code>maps/02_06_theta_tunnels_old/02_06_theta_tunnels.hps</code>, SOMA calls <code>Infection_CreateBorderTree</code> as follows.

<syntaxhighlight lang="cpp">
Infection_CreateBorderTree(1, 30, cVector2f(14,35), 3.0f);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>alBorder</code> || <code>1</code>
|-
| <code>afOffset</code> || <code>30</code>
|-
| <code>avSize</code> || <code>cVector2f(14,35)</code>
|-
| <code>afSpeed</code> || <code>3.0f</code>
|}

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

=== Infection_ClearTrees ===
Clears all created trees.

In <code>script/modules/PlayerEnergyHandler.hps</code>, SOMA calls <code>Infection_ClearTrees</code> as follows.

<syntaxhighlight lang="cpp">
Infection_ClearTrees();
</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.

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

[[Category:English]]

HPL3/SOMA/Scripting/Infection Handler - Revision history

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