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

2026-10-02T12:18:06Z

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

New page

{{shortPageTitle}}

SOMA provides the Time Glitch script in <code>script/effects/Effect_TimeGlitch.hps</code>.

Time glitch jumps physics and visuals forward in time and temporarily speeds up sounds. Its arguments select the amount of time advanced, the time sounds run faster, the shake amount, whether an effect sound plays and that sound’s volume.

== 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_TimeGlitch_Start ===
Starts an effect that makes physics and visual jump forward in time.

{| class="wikitable"
! Parameter !! Meaning
|-
| <code>afTimeAdvancement</code> || The amount of time physics and visuals should advance.
|-
| <code>afPlayFastSoundTime</code> || How long the sounds should run sped up. (sound freq depends on the time advancement + this time)
|-
| <code>afShakeAmount</code> || How much the screen should shake.
|-
| <code>abPlayEffectSound</code> || If an effect sound should play.
|-
| <code>afSoundEffectVolume</code> || Volume of the sound being played.
|}

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

<syntaxhighlight lang="cpp">
Effect_TimeGlitch_Start(2, 0.5, 0.2, true);
</syntaxhighlight>

{| class="wikitable"
! Parameter !! Value in this stock call
|-
| <code>afTimeAdvancement</code> || <code>2</code>
|-
| <code>afPlayFastSoundTime</code> || <code>0.5</code>
|-
| <code>afShakeAmount</code> || <code>0.2</code>
|-
| <code>abPlayEffectSound</code> || <code>true</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.

== Read the example ==
In the transport-station example, physics and visuals advance by 2, sounds run sped up for 0.5, the shake amount is 0.2 and the effect sound is enabled. The omitted sound-volume argument uses the declaration’s <code>1.0f</code> default. These arguments describe one glitch; they do not define a repeating interval.

== See also ==
* [[HPL3/SOMA/Scripting/Effects Helper|SOMA effects helpers]]

[[Category:English]]

HPL3/SOMA/Scripting/Time Glitch - Revision history

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