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

2026-10-02T12:19:06Z

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

New page

{{shortPageTitle}}

SOMA provides the Gamepad script in <code>script/effects/Effect_Gamepad.hps</code>.

The Gamepad effect manages controller rumble. Effect_Rumble_Start returns an instance ID, Effect_Rumble_Stop stops that ID, and the screen-shake multiplier controls rumble generated from screen shake.

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

=== Effect_Rumble_Start ===
Start a gamepad rumble

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>afAmount</code> || strength of the rumble, between 0-1
|-
| <code>afTime</code> || duration of the rumble
|-
| <code>afFadeInTime</code> || fade time in the start
|-
| <code>afFadeOutTime</code> || fade time at the end
|}

In <code>maps/chapter01/01_04_transport_station/01_04_transport_station.hps</code>, SOMA calls <code>Effect_Rumble_Start</code> as follows.

<syntaxhighlight lang="cpp">
Effect_Rumble_Start(1, 2, 2);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>afAmount</code> || <code>1</code>
|-
| <code>afTime</code> || <code>2</code>
|-
| <code>afFadeInTime</code> || <code>2</code>
|}

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

=== Effect_Rumble_Stop ===
Stops the rumble from this id

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>alID</code> || id for the rumble instance, -1 to stop all
|}

In <code>maps/chapter02/02_02_ms_curie_inside/02_02_ms_curie_inside.hps</code>, SOMA calls <code>Effect_Rumble_Stop</code> as follows.

<syntaxhighlight lang="cpp">
Effect_Rumble_Stop(mlCrashRumbleId);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>alID</code> || <code>mlCrashRumbleId</code>
|}

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

=== Effect_Rumble_SetScreenShakeMul ===
Sets a multiplier for how much rumble should be generated from screenshake.

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>afX</code> || multiplier to set. 1 is default.
|}

== 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/Effects Helper|SOMA effects helpers]]

[[Category:English]]

HPL3/SOMA/Scripting/Gamepad - Revision history

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