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

2026-10-02T12:19:34Z

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/Area_Interface.hps</code>.

Area scripts inherit iScrArea to access the native cLuxArea through mBaseObj. SetupBaseInterface stores that handle and GetBase returns it. Specialized area helpers operate on the area’s behavior, such as moving ordinary areas or attaching objects to sticky areas.

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

=== Area_MoveLinearTo ===
Moves the specified area to the current position of the target entity.
!Does not work on Liquid Areas, instead use LiquidArea_MoveLinearTo!

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>asName</code> || name of the area to move, wildcard(s) * are supported.
|-
| <code>asTargetEntity</code> || name of the entity to move the area to.
|-
| <code>afAcceleration</code> || acceleration .in m/s^2
|-
| <code>afMaxSpeed</code> || the maximum speed of movement.
|-
| <code>afSlowDownDist</code> || the distance at which movement slows down.
|-
| <code>abResetSpeed</code> || if all static movement for the area should be stopped before starting this movement.
|-
| <code>asCallback</code> || callback when movement is done: void asCallback(const tString& in asAreaName)
|}

In <code>maps/_e3/_e3_01_01/_e3_01_01.hps</code>, SOMA calls <code>Area_MoveLinearTo</code> as follows.

<syntaxhighlight lang="cpp">
Area_MoveLinearTo("RunningSoundSource","RunningSoundSource_Target",2.2f,5.0f);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>asName</code> || <code>"RunningSoundSource"</code>
|-
| <code>asTargetEntity</code> || <code>"RunningSoundSource_Target"</code>
|-
| <code>afAcceleration</code> || <code>2.2f</code>
|-
| <code>afMaxSpeed</code> || <code>5.0f</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/Areas - Revision history

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