<?xml version="1.0" encoding="utf-8"?>
<!-- generator="FeedCreator 1.7.2-ppt DokuWiki" -->
<?xml-stylesheet href="https://oldwiki.frictionalgames.com/lib/exe/css.php?s=feed" type="text/css"?>
<feed xmlns="http://www.w3.org/2005/Atom">
    <title>Frictional Game Wiki hpl3:game:scripting:user_modules</title>
    <subtitle></subtitle>
    <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/"/>
    <id>https://oldwiki.frictionalgames.com/</id>
    <updated>2026-06-13T00:52:07+00:00</updated>
    <generator>FeedCreator 1.7.2-ppt DokuWiki</generator>
<link rel="self" type="application/atom+xml" href="https://oldwiki.frictionalgames.com/feed.php" />
    <entry>
        <title>Attack Meter</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/attack_meter?rev=1442410798&amp;do=diff"/>
        <published>2015-09-16T13:39:58+00:00</published>
        <updated>2015-09-16T13:39:58+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/attack_meter?rev=1442410798&amp;do=diff</id>
        <summary>Attack Meter

Helper function prefix: AttackMeter_

The attack meter module is used to tell the player that they are in danger and, if they don't escape the danger in time, applies damage to them, knocks them down and kills them. It's used by AI agents, and also for when (for example) the player jumps off a cliff.</summary>
    </entry>
    <entry>
        <title>Camera Animation</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/camera_animation?rev=1442406316&amp;do=diff"/>
        <published>2015-09-16T12:25:16+00:00</published>
        <updated>2015-09-16T12:25:16+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/camera_animation?rev=1442406316&amp;do=diff</id>
        <summary>Camera Animation

Helper function prefix: CameraAnimation_, CameraAnimationNode_

General

The camera animation system is used to move the player camera along a specific path while still allowing some degree of interaction.

Instructions

To use the system, place CameraAnimation nodes (Area → CameraAnimation) in the scene and give each of them the name of the animation followed by an underscore and their placement within the animation (such as WakeUpAnimation_1, WakeUpAnimation_2 etc). Note that…</summary>
    </entry>
    <entry>
        <title>Credits</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/credits?rev=1442410870&amp;do=diff"/>
        <published>2015-09-16T13:41:10+00:00</published>
        <updated>2015-09-16T13:41:10+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/credits?rev=1442410870&amp;do=diff</id>
        <summary>Credits

Helper function prefix: Credits_

The credits handler simply displays a scrolling list of credits - see config/Credits.cfg for the format used.

Important Functions

Credits_Start

Start the credits rolling.

Credits_stop

Stop the credits.</summary>
    </entry>
    <entry>
        <title>Datamine</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/datamine?rev=1442419393&amp;do=diff"/>
        <published>2015-09-16T16:03:13+00:00</published>
        <updated>2015-09-16T16:03:13+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/datamine?rev=1442419393&amp;do=diff</id>
        <summary>Datamine

Helper function prefix: Datamine_

Datamining is what happens when the player in SOMA touches a dead person, intercom or other piece of technology and hears the last few moments of data buffer as an audio clip. Most of this is handled automatically by</summary>
    </entry>
    <entry>
        <title>Description</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/description?rev=1442402058&amp;do=diff"/>
        <published>2015-09-16T11:14:18+00:00</published>
        <updated>2015-09-16T11:14:18+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/description?rev=1442402058&amp;do=diff</id>
        <summary>Description

Helper function prefix: Description_

The description handler is an old module pre-SOMA; it's for adding descriptive text on-screen. SOMA uses Readables and ZoomAreas instead. Description may not be fully up-to-date with SOMA's code.</summary>
    </entry>
    <entry>
        <title>Distortion Effects</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/distortion_effects?rev=1442410968&amp;do=diff"/>
        <published>2015-09-16T13:42:48+00:00</published>
        <updated>2015-09-16T13:42:48+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/distortion_effects?rev=1442410968&amp;do=diff</id>
        <summary>Distortion Effects

Helper function prefix: DistortionEffect_

This module implements the distortion effects that happen to the player's vision as they get close to enemy creatures such as the Flesher. It's called automatically from some AI, but it's also possible to explicitly add additional distortion effects e.g. to trigger effects in a particular area.</summary>
    </entry>
    <entry>
        <title>Emotion</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/emotion?rev=1442412278&amp;do=diff"/>
        <published>2015-09-16T14:04:38+00:00</published>
        <updated>2015-09-16T14:04:38+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/emotion?rev=1442412278&amp;do=diff</id>
        <summary>Emotion

Helper function prefix: Emotion_

This module implements heavy breathing and heartbeats effects, allowing you to programmatically change volume and rate of both.

Important Functions

Emotion_StartHeartbeat

Start a regular heartbeat sound.</summary>
    </entry>
    <entry>
        <title>Game Over</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/game_over?rev=1442412318&amp;do=diff"/>
        <published>2015-09-16T14:05:18+00:00</published>
        <updated>2015-09-16T14:05:18+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/game_over?rev=1442412318&amp;do=diff</id>
        <summary>Game Over

Helper function prefix: GameOver_

This module implements the death screen, and the weird sequence of images you get just before death. It's automatically called by the AttackHandler; you shouldn't need to call it directly.</summary>
    </entry>
    <entry>
        <title>Highlight Effect</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/highlight_effect?rev=1442412359&amp;do=diff"/>
        <published>2015-09-16T14:05:59+00:00</published>
        <updated>2015-09-16T14:05:59+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/highlight_effect?rev=1442412359&amp;do=diff</id>
        <summary>Highlight Effect

This module manages the highlighting of particular interactive objects in an area near to the player. This will be handled automatically - there are no helper functions to call.</summary>
    </entry>
    <entry>
        <title>Hint</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/hint?rev=1442412695&amp;do=diff"/>
        <published>2015-09-16T14:11:35+00:00</published>
        <updated>2015-09-16T14:11:35+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/hint?rev=1442412695&amp;do=diff</id>
        <summary>Hint

Helper function prefix: Hint_

This module handles the textual hints (with embedded button symbols) that pop up at the top of the screen. You can embed button or keyboard symbols in the hints - see the Hints section in english.lang for details.</summary>
    </entry>
    <entry>
        <title>Inventory</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/inventory?rev=1442402254&amp;do=diff"/>
        <published>2015-09-16T11:17:34+00:00</published>
        <updated>2015-09-16T11:17:34+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/inventory?rev=1442402254&amp;do=diff</id>
        <summary>Inventory

Helper function prefix: Inventory_

The inventory module handles the display of the player's inventory (the management of it is done in PlayerToolHandler).</summary>
    </entry>
    <entry>
        <title>Light Flash</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/light_flash?rev=1442415276&amp;do=diff"/>
        <published>2015-09-16T14:54:36+00:00</published>
        <updated>2015-09-16T14:54:36+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/light_flash?rev=1442415276&amp;do=diff</id>
        <summary>Light Flash

Helper function prefix: LightFlash_

The light flash module handles the display of a flash effect of bright light at the particular positions in the 3D world.

Important Functions

LightFlash_Add

Add a bright light flash either at an entity position or directly at a location.</summary>
    </entry>
    <entry>
        <title>Map Effects</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/map_effects?rev=1442415844&amp;do=diff"/>
        <published>2015-09-16T15:04:04+00:00</published>
        <updated>2015-09-16T15:04:04+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/map_effects?rev=1442415844&amp;do=diff</id>
        <summary>Map Effects

Helper function prefix: Map_

The Map Effects module handles a variety of different helpers for the map's effects, including fog and environment particles. It also manages collections of environmental presets to fade between, so you can transition a map's appearance from one state to another.</summary>
    </entry>
    <entry>
        <title>Menu</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/menu?rev=1442402353&amp;do=diff"/>
        <published>2015-09-16T11:19:13+00:00</published>
        <updated>2015-09-16T11:19:13+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/menu?rev=1442402353&amp;do=diff</id>
        <summary>Menu

Helper function prefix: MainMenu_, PauseMenu_

The MenuHandler module implements all of SOMA's front-end menus.</summary>
    </entry>
    <entry>
        <title>Player Energy</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_energy?rev=1442402381&amp;do=diff"/>
        <published>2015-09-16T11:19:41+00:00</published>
        <updated>2015-09-16T11:19:41+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_energy?rev=1442402381&amp;do=diff</id>
        <summary>Player Energy

Helper function prefix: PlayerEnergy_

The Player Energy module implements the recharging of the player's health (through use of 'Wau Flowers') in SOMA. 'Wau Flowers' themselves are of type Prop_EnergySource.</summary>
    </entry>
    <entry>
        <title>Player Hands</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_hands?rev=1442416498&amp;do=diff"/>
        <published>2015-09-16T15:14:58+00:00</published>
        <updated>2015-09-16T15:14:58+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_hands?rev=1442416498&amp;do=diff</id>
        <summary>Player Hands

Helper function prefix: PlayerHands_

The Player Hands module implements all the animations that the first-person player hands take in game. It also allows binding the camera to a socket on the player hands animation for custom 'cut-scene'-like moments, such as climbing out of the dome in Upsilon.</summary>
    </entry>
    <entry>
        <title>Player Tool</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_tool?rev=1442417859&amp;do=diff"/>
        <published>2015-09-16T15:37:39+00:00</published>
        <updated>2015-09-16T15:37:39+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/player_tool?rev=1442417859&amp;do=diff</id>
        <summary>Player Tool

Helper function prefix: Player_

This module handles the player's use of Prop_Tool objects that they pick up, including maintaining an inventory list, deciding if a tool is equipped (shown in the player's hands) and whether tools can be used on particular entities or areas. In SOMA, this covers things like the Omnitool or scan chips.</summary>
    </entry>
    <entry>
        <title>Wake Handler</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/wake_handler?rev=1442417509&amp;do=diff"/>
        <published>2015-09-16T15:31:49+00:00</published>
        <updated>2015-09-16T15:31:49+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/user_modules/wake_handler?rev=1442417509&amp;do=diff</id>
        <summary>Wake Handler

Helper function prefix: Wake_

This implements a very simple wakeup effect, as if blinking eyelids (see the start of the Theta labyrinth after Akers has embedded you in coral). We implemented this as a module because we originally planned to use it in a few places; in the end we only needed it once.</summary>
    </entry>
</feed>
