<?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:function_reference</title>
    <subtitle></subtitle>
    <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/"/>
    <id>https://oldwiki.frictionalgames.com/</id>
    <updated>2026-04-25T12:44:21+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>helper_ai.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_ai?rev=1446109795&amp;do=diff"/>
        <published>2015-10-29T09:09:55+00:00</published>
        <updated>2015-10-29T09:09:55+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_ai?rev=1446109795&amp;do=diff</id>
        <summary>helper_ai.hps

Helper functions for AI

----------

Agent_SetStaticCollider


void Agent_SetStaticCollider(const tString &amp;in asAgentName,
                             bool abX)


Set if the agent will collide with the environment (objects and stuff will still collide with it!)</summary>
    </entry>
    <entry>
        <title>helper_areas.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_areas?rev=1446110008&amp;do=diff"/>
        <published>2015-10-29T09:13:28+00:00</published>
        <updated>2015-10-29T09:13:28+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_areas?rev=1446110008&amp;do=diff</id>
        <summary>helper_areas.hps

Helper functions to handle area objects

----------

Area_MoveLinearTo


void Area_MoveLinearTo(const tString &amp;in asName,
                       const tString &amp;in asTargetEntity,
                       float afAcceleration,
                       float afMaxSpeed,
                       float afSlowDownDist=0.0f,
                       bool abResetSpeed=true,
                       const tString &amp;in asCallback=&quot;&quot;)</summary>
    </entry>
    <entry>
        <title>helper_audio.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_audio?rev=1446110123&amp;do=diff"/>
        <published>2015-10-29T09:15:23+00:00</published>
        <updated>2015-10-29T09:15:23+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_audio?rev=1446110123&amp;do=diff</id>
        <summary>helper_audio.hps

Helper functions for handling sound, music and dialogue

_Sound_Global_EntryAffected


bool _Sound_Global_EntryAffected(int alIdx,
                                 eSoundEntryType aAffectedTypes)


----------

Sound_SetGlobalSpeed


void Sound_SetGlobalSpeed(float afFreq,
                          eSoundEntryType aAffectedTypes=eSoundEntryType_WorldAll)</summary>
    </entry>
    <entry>
        <title>helper_effects.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_effects?rev=1446110863&amp;do=diff"/>
        <published>2015-10-29T09:27:43+00:00</published>
        <updated>2015-10-29T09:27:43+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_effects?rev=1446110863&amp;do=diff</id>
        <summary>helper_effects.hps

Helper functions to control effects

----------

Effect_Shake_Start


int Effect_Shake_Start(float afAmount,
                       float afTime,
                       float afFadeInTime,
                       float afFadeOutTime,
                       const cVector3f &amp;in avDirAmount=cVector3f(1, 1, 1),
                       float afFrequency=0)</summary>
    </entry>
    <entry>
        <title>helper_game.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_game?rev=1446110965&amp;do=diff"/>
        <published>2015-10-29T09:29:25+00:00</published>
        <updated>2015-10-29T09:29:25+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_game?rev=1446110965&amp;do=diff</id>
        <summary>helper_game.hps

----------

Platform_GetName


tString Platform_GetName()


----------

Platform_IsPS4


bool Platform_IsPS4()


----------

Game_AutoSave


void Game_AutoSave(bool abSaveCheckpoint=true,
                   bool abDelayed=true)


Saves the current postion of the game.</summary>
    </entry>
    <entry>
        <title>helper_imgui.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_imgui?rev=1446897113&amp;do=diff"/>
        <published>2015-11-07T11:51:53+00:00</published>
        <updated>2015-11-07T11:51:53+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_imgui?rev=1446897113&amp;do=diff</id>
        <summary>helper_imgui.hps

ImGui_ClearStates


void ImGui_ClearStates()


Clears all states, timers, variables, etc.

----------

ImGui_InFocus


bool ImGui_InFocus()


If the current ImGui is in focus.

----------

ImGui_BecameInFocus


bool ImGui_BecameInFocus()</summary>
    </entry>
    <entry>
        <title>helper_map.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_map?rev=1446111133&amp;do=diff"/>
        <published>2015-10-29T09:32:13+00:00</published>
        <updated>2015-10-29T09:32:13+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_map?rev=1446111133&amp;do=diff</id>
        <summary>helper_map.hps

Helper functions for dealing with map related stuff

----------

Map_GetTimeStamp


int Map_GetTimeStamp()


This gets the number of ticks (60/second is default) since start of map.

----------

Map_GetElapsedTime


float Map_GetElapsedTime(int alTimeStamp)</summary>
    </entry>
    <entry>
        <title>helper_modules.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_modules?rev=1446111195&amp;do=diff"/>
        <published>2015-10-29T09:33:15+00:00</published>
        <updated>2015-10-29T09:33:15+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_modules?rev=1446111195&amp;do=diff</id>
        <summary>helper_modules.hps

Helper functions interfacing with game module objects

----------

Description_AddExt


int Description_AddExt(const tString &amp;in asTextCat,
                       const tString &amp;in asTextEntry,
                       float afTimeMul,
                       bool abPutInQueueIfShowing,
                       bool abConnectedToPrevious,
                       eDescEffect aEffect,
                       float afEffectAmount,
                       cColor aColor)</summary>
    </entry>
    <entry>
        <title>helper_player.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_player?rev=1446111217&amp;do=diff"/>
        <published>2015-10-29T09:33:37+00:00</published>
        <updated>2015-10-29T09:33:37+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_player?rev=1446111217&amp;do=diff</id>
        <summary>helper_player.hps

----------

Player_GetPosition


cVector3f Player_GetPosition()


Gets the position of the player.

 Returns: cVector3f , The position of the player.

----------

Player_GetFeetPosition


cVector3f Player_GetFeetPosition()


Gets the feet position of the player.</summary>
    </entry>
    <entry>
        <title>helper_props.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_props?rev=1446111352&amp;do=diff"/>
        <published>2015-10-29T09:35:52+00:00</published>
        <updated>2015-10-29T09:35:52+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_props?rev=1446111352&amp;do=diff</id>
        <summary>helper_props.hps

----------

SwingDoor_PushOpen


void SwingDoor_PushOpen(const tString &amp;in asName,
                        float afImpulseAmount,
                        int alNumOfTimes=1,
                        float afTimeBetweenPushes=0.1)


Pushes a door open using one or many impulses</summary>
    </entry>
    <entry>
        <title>helper_sequences.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_sequences?rev=1446111334&amp;do=diff"/>
        <published>2015-10-29T09:35:34+00:00</published>
        <updated>2015-10-29T09:35:34+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/helper_sequences?rev=1446111334&amp;do=diff</id>
        <summary>helper_sequences.hps

Helper functions for creating sequences of events

----------

Sequence_Begin


void Sequence_Begin(const tString &amp;in asFunction,
                    cSequenceStatesData &amp;aData)


Begins to define a sequence of events. Note that the entire specified function will be run once for every sequence step.</summary>
    </entry>
    <entry>
        <title>hps_api.hps</title>
        <link rel="alternate" type="text/html" href="https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/hps_api?rev=1446110644&amp;do=diff"/>
        <published>2015-10-29T09:24:04+00:00</published>
        <updated>2015-10-29T09:24:04+00:00</updated>
        <id>https://oldwiki.frictionalgames.com/hpl3/game/scripting/function_reference/hps_api?rev=1446110644&amp;do=diff</id>
        <summary>hps_api.hps

----------

GetBase


iLuxAchievementHandler GetBase()


----------

CharBody_GravityCollide


void CharBody_GravityCollide(iCharacterBody @apCharBody,
                             iPhysicsBody @apBody,
                             cCollideData @apCollideData)</summary>
    </entry>
</feed>
