Frictional Game Wiki

<h1>Engine Scripts</h1> <div class="level1"> </div> <h2>Basic Code</h2> <div class="level2"> <p> This page is here as a reference documentation available online covering the main script functions within HPL3. These are the ones included by default and are found within the <b>hps_api.hps</b> file located in the SOMA game directory. </p> <p> &lt;note>This is a work-in-progress page. In time, it will contain much more than just the helpers.&lt;/note> </p> </div> <h3>Entity</h3> <div class="level3"> <pre class="code =c++">bool Entity_Exists<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> bool Entity_Exists<span class="br0">(</span>tID aID<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Check if an entity exists in the level. Returns <b>true </b> if found. </p> <p> <em>asName </em>- the name of the entity to search for.<br/> OR<br/> <em>aID </em>- the ID of the entity to search for. </p> <pre class="code =c++">bool Entity_SetActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Set whether an entity is active (visible and functioning) or not. </p> <p> <em>asName </em>- the name of the entity (wildcards * are supported).<br/> <em>abActive </em>- if active or not. </p> <pre class="code =c++">bool Entity_IsActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Check if an entity is active (visible and functioning) or not. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported). </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetInteractionDisabled<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets whether an entity can be interacted with by the player or not. </p> <p> <em>asEntityName</em> - the name of the entity (wildcards * are supported).<br/> <em>abX</em> - true = interaction disabled | false = interaction enabled. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetMaxInteractionDistance<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afDistance<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Override the default max distance an entity can be interacted with. </p> <p> <em>asEntityName</em> - the name of the entity (wildcards * are supported).<br/> <em>afDistance</em> - the distance (in meters) the entity can be interacted with from. </p> <pre class="code =c++">bool Entity_IsInteractedWith<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Checks whether an entity is being interacted with. </p> <p> <em>asName</em> - the name of the entity. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_Sleep<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Forces the entity to sleep. This disables Update and PostUpdate. Has no effect if entity is already sleeping. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported). </p> <pre class="code =c++"><span class="kw4">void</span> Entity_WakeUp<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Wakes a sleeping entity. This enabled Update and PostUpdate. Has no effect if entity is already awake. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported). </p> <pre class="code =c++">bool Entity_IsSleeping<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Checks whether an entity is asleep. </p> <p> <em>asName</em> - the name of the entity. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetAutoSleep<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets whether an entity should automatically sleep when it doesn't require updates. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported).<br/> <em>abX</em> - enabled or disabled. </p> <pre class="code =c++">bool Entity_GetAutoSleep<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Gets whether an entity automatically goes to sleep when it doesn't require updates. </p> <p> <em>asName</em> - the name of the entity. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetIsOccluder<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abOccluder<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Set whether an entity is an occluder. </p> <p> <em>asName</em> - the name of the entity (wildcards (&lt;nowiki>&#42;&lt;/nowiki>) are supported).<br/> <em>abOccluder</em> - enabled or disabled. </p> <pre class="code =c++">bool Entity_IsOccluder<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Checks whether an entity is an occluder. </p> <p> <em>asName</em> - the name of the entity. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetVarString<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarBool<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarInt<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">int</span> alX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarFloat<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> bool afX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarVector2f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> cVector2f<span class="sy0">&</span>in avX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarVector3f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f<span class="sy0">&</span>in avX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_SetVarColor<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> cColor<span class="sy0">&</span>in aX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets a value of an entity variable. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported).<br/> <em>asVarName</em> - the name of the variable for the entity.<br/> <em>aX</em> - the value of the variable. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_IncVarInt<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">int</span> alX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_IncVarFloat<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_IncVarVector2f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> cVector2f<span class="sy0">&</span>in avX<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">void</span> Entity_IncVarVector3f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f<span class="sy0">&</span>in avX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Increments a value of an entity variable. </p> <p> <em>asName</em> - the name of the entity (wildcards * are supported).<br/> <em>asVarName</em> - the name of the variable for the entity.<br/> <em>aX</em> - the value to add. </p> <pre class="code =c++">tString Entity_GetVarString<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> bool Entity_GetVarBool<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">int</span> Entity_GetVarInt<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> <span class="kw4">float</span> Entity_GetVarFloat<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> cVector2f Entity_GetVarVector2f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> cVector3f Entity_GetVarVector3f<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> cColor Entity_GetVarColor<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString<span class="sy0">&</span>in asVarName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Gets the value of an entity variable. </p> <p> <em>asName</em> - the name of the entity.<br/> <em>asVarName</em> - the name of the variable for the entity. </p> <pre class="code =c++">bool Entity_AddCollideCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asParentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asChildName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asFunction<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Adds a callback between two entities (objects, areas, player etc) when they collide with each other. Collisions include when "uncolliding" as well. Wildcards * are supported in names. </p> <p> <em>asParentName</em> - the first entity (for player collisions, this is always the player)<br/> <em>asChildName</em> - the second entity to check against.<br/> <em>asFunction</em> - name of the callback function for when these objects collide. </p> <p> Callback syntax:<br/> <b>FunctionName(const tString &in asParent, const tString &in asChild, int alState)</b><br/> <em>alState</em> - 1 = colliding, -1 = uncolliding, 0 = both.<br/> </p> <p> <b>Returns</b> whether the callback is repeated upon completetion. If true, callback can be called again. If false, callback is removed.<br/> Abbreviation syntax for the callback function code snippet: <b>clbCollide</b> </p> </div> <h2>Helper Files</h2> <div class="level2"> <p> Helper files are seperate .hps files which contain many further functions and codes which are of use to the developer. The following are grouped by their helper file name. In order to use these, you need to specify with an #include &lt;helper.hps> at the top of your code, which is done automatically when you save your map for the first time. These codes are found in SOMA/script/helpers/ , and are grouped on this page under which one you require. To search this, from most browsers, you can press Ctrl+F and start typing in a term. </p> </div> <h3>A.I</h3> <div class="level3"> <p> The following codes require #include “helpers/helper_ai.hps”. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_FaceEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asLookAtTarget<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Instantly sets the yaw of the agent to make it look at the specified entity. </p> <p> <em>asAgentName</em> - Name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>asLootAtTarget</em> - Name of entity to look at. </p> <pre class="code =c++">bool Agent_PlayerDetected<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Gets if the player has been detected by an agent. Returns true if so. </p> <p> <em>asAgentName</em> - Name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_RevealPlayerPosition<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool bForceRedetect<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Reveals the player's current position to the agent. </p> <p> <em>asAgentName</em> - name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_SetAutoDisableCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the function that is called when the disabling made by Agent_SetAutoDisableWhenOutOfSightActive(); happens </p> <p> <em>asAgentName</em> - name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>asCallbackFunc</em> - Function called when the disabling happens.<br/> <b>Callback syntax:</b> void MyFunc(const tString&in asEntityName) </p> <pre class="code =c++"><span class="kw4">void</span> Agent_SetAutoDisableWhenOutOfSightActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afMinDistance<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> When active, the agent will be a disabled (SetActive(false)) when a certain distance away from the player and no longer seen. </p> <p> <em>asAgentName</em> - name of the agent.Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>abActive</em> - if the disabling is active (should be disabled = true)<br/> <em>afMinDistance</em> - The minimum distance from the player for this to happen. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_SetSensesActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Set if the agent should have its senses (hearing/vision/etc) enabled. </p> <p> <em>asAgentName</em> - name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>abX</em> - If the senses should be active. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_SetStaticCollider<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Set if the agent will collide with the environment (objects and stuff will still collide with it!) </p> <p> <em>asAgentName</em> - name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>abX</em> - If the character should be static and NOT move about. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_SetViewRangeMul<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">float</span> afRangeMul<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the view range multiplier of the specified agent </p> <p> <em>asAgentName</em> - name of the agent. Wildcard (&lt;nowiki>&#42;&lt;/nowiki>) supported.<br/> <em>afRangeMul</em> - the range multiplier to set. </p> <pre class="code =c++"><span class="kw4">void</span> Agent_TeleportFeetToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTargetName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Teleport the agent's foot position to a specific other entity. </p> <p> <em>asAgentName</em> - name of the entity to teleport.<br/> <em>asTargetName</em> - name of the entity to teleport to. </p> </div>