Frictional Game Wiki

<h1>Engine Scripts</h1> <div class="level1"> <p> This page is here as a reference documentation available online covering the main script functions within HPL3. The Basic Code section contains scripts that are available by default and found within the <b>hps_api.hps</b> file located in the SOMA game directory. Under "Helper Files" you will find the functions referenced in the specific helper files which require a script import from the script folder. </p> <p> &lt;note>This is a work-in-progress page. In time, it will contain much more, including all built-in functions, helper files and possibly more.&lt;/note> </p> </div> <h2>Basic Code</h2> <div class="level2"> <p> The code referenced here is included by default in the game, and can be accessed without the use of a #include statement, contrary to the helper scripts. Each function is followed by a short description, argument explanations and callback syntax (if used). </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> a boolean of 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> <pre class="code =c++">bool Entity_RemoveCollideCallback<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="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Removes a callback for entity collisions. Wildcards * supported in names. </p> <p> <em>asParentName</em> - the first entity (for player collisions, this is always player)<br/> <em>asChildName</em> - the second entity. </p> <pre class="code =c++">bool Entity_GetCollide<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityA<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityB<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Check whether two entities are already colliding. Wildcards * are NOT supported. </p> <p> <em>asEntityA</em> - the first entity.<br/> <em>asEntityB</em> - the second entity. </p> <p> Returns true if colliding, else false. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetCollideCharacter<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Enable/disable an entity's collision with a character for all bodies in the entity. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>abActive</em> - true = collision on, false = collision off. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetCollide<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Enable/disable an entity's collision for all bodies in the entity. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>abActive</em> - true = collision on, false = collision off. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetEffectsActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> bool abFadeAndPlaySounds<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Enables/disables whether an entity uses effects. </p> <p> <em>asEntityName</em> - name of the entity/prop. Wildcards * are supported.<br/> <em>abActive</em> - true = activates effects, false = deactivates effects.<br/> <em>abFadeAndPlaySounds</em> - if effects should fade in/out and play sounds. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetReflectionVisibility<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abVisibleInReflection<span class="sy0">,</span> bool abVisibleInWorld<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets whether an entity is drawn in reflections or not, and/or in the real world or not. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>abVisibleInReflection</em> - whether the entity is drawn in reflections.<br/> <em>abVisibleInWorld</em> - whether the entity is drawn in the real world. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetEffectBaseColor<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> cColor<span class="sy0">&</span>in aColor<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the base color for the entity's effects. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>aColor</em> - the color all effects will be multiplied with. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_FadeEffectBaseColor<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> cColor<span class="sy0">&</span>in aColor<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Fades the base color for the entity's effects. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>aColor</em> - the color all effects will be faded to.<br/> <em>afTime</em> - the time in seconds the fade takes to finish. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_SetColorMul<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> cColor<span class="sy0">&</span>in aColor<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the color multiplier of the entity. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>aColor</em> - the color to set the multiplier to. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_AddForce<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> cVector3f <span class="sy0">&</span>in avForce<span class="sy0">,</span> bool abLocalSpace<span class="sy0">,</span> bool abOnlyMainBody<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Adds a push force to the entity. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>avForce</em> - the force to add.<br/> <em>abLocalSpace</em> - true = local force is added relative to the rotation of the entity, false = global force is added in a world space<br/> <em>abOnlyMainBody</em> - true = force is added only to the main body of the entity, false = force is added to all bodies of the entity. </p> <pre class="code =c++"><span class="kw4">void</span> Entity_AddForceFromEntity<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 asForceEntityName<span class="sy0">,</span> <span class="kw4">float</span> afForce<span class="sy0">,</span> bool abOnlyMainBody<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Adds a push force to the entity away from another entity. </p> <p> <em>asEntityName</em> - the name of the entity. Wildcards * are supported.<br/> <em>asForceEntityName</em> - the name of the entity to push away from.<br/> <em>afForce</em> - magnitude of the force. Negative values attract the entity to the force entity. </p> <p> <img src="/lib/exe/fetch.php?media=hpl3:community:scripting:wip-icon.png" class="media" alt="" /> WORK IN PROGRESS <img src="/lib/exe/fetch.php?media=hpl3:community:scripting:wip-icon.png" class="media" alt="" /> </p> </div> <h3>Material</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Material_Preload<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFile<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Preloads a material </p> <p> <em>asFile</em> - the .mat material file to preload. </p> </div> <h3>Prop</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Prop_SetHealth<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asPropName<span class="sy0">,</span> <span class="kw4">float</span> afHealth<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the health of a prop. Can be used to destroy objects. </p> <p> <em>asPropName</em> - name of the prop. Wildcards * supported.<br/> <em>afHealth</em> - the health to set. </p> </div> <h3>Lamp</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Lamp_SetLit<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> bool abLit<span class="sy0">,</span> bool abEffects<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the lit state of a lamp. </p> <p> <em>asName</em> - name of the lamp.<br/> <em>abLit</em> - true = lamp is lit, false = lamp is unlit.<br/> <em>abEffects</em> - whether the change should use effects associated with it. If false, the change will not be apparent to the player. </p> </div> <h3>SwingDoor</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> SwingDoor_SetOpenAmount<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> <span class="kw4">float</span> afOpenAmount<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets a swing door to a specific open state instantly. </p> <p> <em>asName</em> - name of the prop. Wildcards * supported.<br/> <em>afOpenAmount</em> - 0 = closed, 1 = completely open. 0.5f = half state. </p> </div> <h3>PhysicsSlideDoor</h3> <div class="level3"> <pre class="code =c++">bool PhysicsSlideDoor_GetClosed<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> Returns true if the door is closed, else false. </p> <p> <em>asName</em> - name of the door. </p> </div> <h3>SlideDoor</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> SlideDoor_SetClosed<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> bool abClosed<span class="sy0">,</span> bool abInstant <span class="sy0">=</span> <span class="kw2">false</span><span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the close state of a SlideDoor. Simplified version of SlideDoor_SetOpenAmount. </p> <p> <em>asName</em> - name of the door.<br/> <em>abClosed</em> - true = close, false = open.<br/> <em>abInstant</em> (optional) - whether the door should slide to the correct state or just have the new position set instantly. </p> </div> <h3>Slide</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Slide_SetSlideAmount<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> <span class="kw4">float</span> afAmount<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the slide amount of a Slide prop, 0 being its minimum position and 1 being its maximum. </p> <p> <em>asName</em> - name of the prop.<br/> <em>afAmount</em> - the slide amount. </p> </div> <h3>Wheel</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">int</span> Wheel_GetState<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 the state of a wheel. </p> <p> <em>asName</em> - name of the wheel. </p> <p> Returns -1 for minimum, 0 for middle, 1 for maximum state. </p> </div> <h3>Lever</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">int</span> Lever_GetState<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 the state of a lever. </p> <p> <em>asName</em> - name of the lever. </p> <p> Returns -1 for minimum, 0 for middle, 1 for maximum state. </p> </div> <h3>Button</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Button_SetSwitchedOn<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> bool abState<span class="sy0">,</span> bool abEffects<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Switches a button on or off. </p> <p> <em>asName</em> - name of the button.<br/> <em>abState</em> - true = on, false = off.<br/> <em>abEffects</em> - whether the change should use effects associated with it. If false, the player will not be apparent to the change. </p> </div> <h3>MovingButton</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> MovingButton_SetSwitchedOn<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> bool abState<span class="sy0">,</span> bool abEffects<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Switches a MovingButton on or off. </p> <p> <em>asName</em> - name of the button.<br/> <em>abState</em> - true = on, false = off.<br/> <em>abEffects</em> - whether the change should use effects associated with it. If false, the player will not be apparent to the change. </p> </div> <h3>LevelDoor</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> LevelDoor_SetLocked<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> bool abState<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets a LevelDoor to be locked or unlocked. </p> <p> <em>asName</em> - name of the level door.<br/> <em>abState</em> - true = locked, false = unlocked. </p> </div> <h3>MoveObject</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> MoveObject_SetState<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> <span class="kw4">float</span> afState<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the state of a move object. This makes it move to a certain position between its minimum and maximum position (or beyond if set to &lt;0 or >1). </p> <p> <em>asName</em> - name of the move object.<br/> <em>afState</em> - the state to set the move object to at speeds defined in the entity file. </p> </div> <h3>Meter</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Meter_SetState<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> <span class="kw4">float</span> afState<span class="sy0">,</span> bool abFadeToState <span class="sy0">=</span> <span class="kw2">true</span><span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the state of the needle object in a meter, which then makes the needle move to the specified state. </p> <p> <em>asName</em> - name of meter object.<br/> <em>afState</em> - percentage of where the needle should be. 0-1 (minimum position - maximum position). <em>abFadeToState</em> - if true, then the needle will fade to the state instead of skipping to it. </p> </div> <h3>Terminal</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Terminal_SetAllowInteraction<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 the terminal should allow interactions from the player. </p> <p> <em>asName</em> - name of the terminal. Wildcards * are supported.<br/> <em>abX</em> - true = allowed, false = denied. </p> </div> <h3>Grab</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Grab_SetForceMul<span class="br0">(</span><span class="kw4">const</span> tString<span class="sy0">&</span> in asName<span class="sy0">,</span> <span class="kw4">float</span> afForceMul<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the force multiplier of a grab prop. </p> <p> <em>asName</em> - name of the grab prop.<br/> <em>afForceMul</em> - the new multiplier. </p> </div> <h3>Readable</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Readable_SetCloseCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallback<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the close callback of a readable prop. </p> <p> <em>asName</em> - name of the readable prop.<br/> <em>asCallback</em> - name of the callback function. </p> <p> Callback syntax: <b>void Function(const tString &in asEntity)</b> </p> </div> <h3>Tool</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Tool_SetAutoHideAfterPickup<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 if a tool should be hidden automatically after getting picked up and being displayed for a brief moment. </p> <p> <em>asName</em> - name of the tool.<br/> <em>abX</em> - true = hide automatically, false = do not hide. </p> </div> <h3>EnergySource</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> EnergySource_SetEnergy<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets the energy level of an energy source. </p> <p> <em>asName</em> - name of the energy source.<br/> <em>afX</em> - the energy amount. </p> </div> <h3>ParticleSystem</h3> <div class="level3"> <pre class="code =c++">cParticleSystem@ ParticleSystem_CreateAtEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asPSName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asPSFile<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEntity<span class="sy0">,</span> bool abAttach<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Create a particle system at an entity or area. </p> <p> <em>asPSName</em> - name of the particle system to be created.<br/> <em>asPSFile</em> - the .ps file to create the particle system from.<br/> <em>asEntity</em> - the entity to create the particle system at. Can be "Player".<br/> <em>abAttach</em> - whether the particle system should attach to the entity it is created at. </p> <p> Returns: The created particle system, or null if the function fails. </p> </div> <h3>Light</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Light_FadeTo<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asLightName<span class="sy0">,</span> <span class="kw4">const</span> cColor <span class="sy0">&</span>in acColor<span class="sy0">,</span> <span class="kw4">float</span> afRadius<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Fades one or more light objects to a specified color and radius. </p> <p> <em>asLightName</em> - name of the light(s). Wildcards * supported.<br/> <em>acColor</em> - the color to fade to.<br/> <em>afRadius</em> - the radius to fade to. If lower than 0, the current radius is used.<br/> <em>afTime</em> - how long it should take until the fade is done. </p> </div> <h3>IrradianceSet</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> IrradianceSet_FadeIn<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asSet<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Fades in the specified set on all probes belonging to it. This also fades out the currently active set for these probes. </p> <p> <em>asSet</em> - the set to fade in.<br/> <em>afTime</em> - how long it should take until the fade is done. </p> </div> <h3>Billboard</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Billboard_SetVisible<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asBillboardName<span class="sy0">,</span> bool abVisible<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets whether a billboard should be rendered or not. </p> <p> <em>asBillboardName</em> - name of the billboard. Wildcards * supported.<br/> <em>abVisible</em> - true = visible, false = invisible. </p> </div> <h3>LensFlare</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> LensFlare_SetVisible<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asLensFlareName<span class="sy0">,</span> bool abVisible<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets if a lens flare should be rendered or not. </p> <p> <em>asLensFlareName</em> - name of lens flare. Wildcards * supported.<br/> <em>abVisible</em> - true = visible, false = invisible. </p> </div> <h3>FogArea</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> FogArea_SetVisible<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFogAreaName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Sets whether a fog area is visible or not. </p> <p> <em>asFogAreaName</em> - name of the fog area.<br/> <em>abActive</em> - true = active, false = inactive. </p> </div> <h3>Map</h3> <div class="level3"> <pre class="code =c++">bool Map_GetParticleSystemArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array< cParticleSystem@<span class="sy0">></span> <span class="sy0">&</span>inout avOutParticles<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Creates an array of particle systems with a given name. </p> <p> <em>asName</em> - name of particle systems. Wildcards * supported.<br/> <em>avOutParticles</em> - reference to array that will be filled with particle systems. </p> </div> <h3>Body</h3> <div class="level3"> <pre class="code =c++"><span class="kw4">void</span> Body_AddForce<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asBodyName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avForce<span class="sy0">,</span> bool abLocalSpace<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Adds push force to a body. </p> <p> <em>asBodyName</em> - the name of the body.<br/> <em>avForce</em> - the push force to apply.<br/> <em>abLocalSpace</em> - true = local force, false = global force. </p> </div> <h3>Joint</h3> <div class="level3"> <pre class="code =c++">bool Joint_IsBroken<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asJointName<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Checks whether the specified joint is broken. </p> <p> <em>asJointName</em> - the name of the joint. </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>