Frictional Game Wiki


<h2>Engine scripts</h2>
<div class="level2">

<p>
<b>Notice</b>: Some of the functions below require the Amnesia 1.3 update. Steam copies should be automatically updated. Other copies can go <a href="http://www.frictionalgames.com/forum/thread-24334.html" class="urlextern" title="http://www.frictionalgames.com/forum/thread-24334.html"  rel="nofollow">here</a>.
</p>

</div>

<h3>Main</h3>
<div class="level3">

<p>
The following functions are the main hps functions that the HPL2 engine looks to run on certain events - similar to the C++ int main() function.
</p>
<pre class="code c++"><span class="kw4">void</span> OnStart<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="br0">}</span>



</pre><p> </p>




<p>
The function that runs when the map is loaded for the first time.
</p>
<pre class="code c++"><span class="kw4">void</span> OnEnter<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="br0">}</span>



</pre><p> </p>




<p>
The function that runs whenever the player enters a map.
</p>
<pre class="code c++"><span class="kw4">void</span> OnLeave<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="br0">}</span>



</pre><p> </p>




<p>
The function that runs when the player leaves a map.
</p>
<pre class="code c++"><span class="kw4">void</span> OnGameStart<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="br0">}</span>



</pre><p> </p>




<p>
This function is found in the global.hps file and the inventory.hps file, and is run when the game is first started by the player (ie via "Start New Game").
</p>

</div>

<h3>General</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">float</span> RandFloat<span class="br0">(</span><span class="kw4">float</span> afMin<span class="sy0">,</span> <span class="kw4">float</span> afMax<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Generates a random float.
</p>

<p>
<em>afMin </em>- minimum value<br/>

<em>afMax </em>- maximum value
</p>
<pre class="code c++"><span class="kw4">int</span> RandInt<span class="br0">(</span><span class="kw4">int</span> alMin<span class="sy0">,</span> <span class="kw4">int</span> alMax<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Generates a random int. Note: the maximum value is <em>inclusive</em> - the RandInt() function may return this value.
</p>

<p>
<em>alMin </em>- minimum value<br/>

<em>alMax </em>- maximum value
</p>
<pre class="code c++">bool StringContains<span class="br0">(</span>string<span class="sy0">&</span> asString<span class="sy0">,</span> string<span class="sy0">&</span> asSubString<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether a string contains the specified string.<br/>

Example: searching for "hello" in "hello world" would return <b>true</b>.
</p>

<p>
<em>asString </em>- the string to check<br/>

<em>asSubString </em>- the string to search for
</p>
<pre class="code c++">string<span class="sy0">&</span> StringSub<span class="br0">(</span>string<span class="sy0">&</span> asString<span class="sy0">,</span> <span class="kw4">int</span> alStart<span class="sy0">,</span> <span class="kw4">int</span> alCount<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Returns the substring in a string.<br/>

Example: in the string "frictional games rocks", using 4 as <em>alStart</em> and 6 as <em>alCount</em> would return <b>"tional"</b>.
</p>

<p>
<em>asString </em>- the string<br/>

<em>alStart </em>- start position in the string<br/>

<em>alCount </em>- amount of characters
</p>
<pre class="code c++"><span class="kw4">int</span> StringToInt<span class="br0">(</span>string<span class="sy0">&</span>in asString<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
If possible, returns an integer converted from a string, else returns 0.
</p>

<p>
<em>asString</em> - String to convert.
</p>
<pre class="code c++"><span class="kw4">float</span> StringToFloat<span class="br0">(</span>string<span class="sy0">&</span>in asString<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
If possible, returns a float converted from a string, else returns 0.
</p>

<p>
<em>asString</em> - String to convert.
</p>
<pre class="code c++">bool StringToBool<span class="br0">(</span>string<span class="sy0">&</span>in asString<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
If possible, returns a boolean converted from a string, else returns false.
</p>

<p>
<em>asString</em> - String to convert.
</p>

</div>

<h3>Mathematical Operations</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">float</span> MathSin<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the sine of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathCos<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the cosine of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathTan<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the tangent of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathAsin<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the arc sine of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathAcos<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the arc cosine of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathAtan<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the arc tangent of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathAtan2<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Calculates and returns the arc tangent of the specified values.
</p>

<p>
<em>afX</em> - First value to operate.<br/>

<em>afY</em> - Second value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathSqrt<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the square root of the specified value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>
<pre class="code c++"><span class="kw4">float</span> MathPow<span class="br0">(</span><span class="kw4">float</span> afBase<span class="sy0">,</span> <span class="kw4">float</span> afExp<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the value of afBase raised to the power of afExp.
</p>

<p>
<em>afBase</em> - The base value.<br/>

<em>afExp</em> - Value to calculate the base with.
</p>
<pre class="code c++"><span class="kw4">float</span> MathMin<span class="br0">(</span><span class="kw4">float</span> afA<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the lowest value.
</p>

<p>
<em>afA</em> - First value.<br/>

<em>afB</em> - Second value.
</p>
<pre class="code c++"><span class="kw4">float</span> MathMax<span class="br0">(</span><span class="kw4">float</span> afA<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the highest value.
</p>

<p>
<em>afA</em> - First value.<br/>

<em>afB</em> - Second value.
</p>
<pre class="code c++"><span class="kw4">float</span> MathClamp<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afMin<span class="sy0">,</span> <span class="kw4">float</span> afMax<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns afX clamped between afMin and afMax. If afX < afMin, returns afMin, and if afX > afMax, returns afMax.
</p>

<p>
<em>afX</em> - The value to clamp.<br/>

<em>afMin</em> - The minimum value to clamp afX with.<br/>

<em>afMax</em> - The maximum value to clamp afX with.
</p>
<pre class="code c++"><span class="kw4">float</span> MathAbs<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the absolute value.
</p>

<p>
<em>afX</em> - Value to operate.
</p>

</div>

<h3>Debugging</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> Print <span class="br0">(</span>string<span class="sy0">&</span> asString<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Prints a string to the log (<code>hpl.log</code>).
</p>
<pre class="code c++"><span class="kw4">void</span> AddDebugMessage<span class="br0">(</span>string<span class="sy0">&</span> asString<span class="sy0">,</span> bool abCheckForDuplicates<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Prints a string to the debug console.
</p>

<p>
<em>asString </em>- the string to print<br/>

<em>abCheckForDuplicates </em>- if true, the string won't be printed more than once on screen until it disappears
</p>
<pre class="code c++"><span class="kw4">void</span> ProgLog<span class="br0">(</span>string<span class="sy0">&</span> asLevel<span class="sy0">,</span> string<span class="sy0">&</span> asMessage<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
?
</p>

<p>
<em>asLevel </em>- can be "Low", "Medium" or "High"<br/>

<em>asMessage </em>- ?
</p>
<pre class="code c++">bool ScriptDebugOn<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether the debug mode is enabled.<br/>

See <a href="/doku.php?id=hpl2:amnesia:devenvguide" class="wikilink1" title="hpl2:amnesia:devenvguide">Setting up Development Environment</a> to setup debug mode on your own computer.
</p>

</div>

<h3>Variables</h3>
<div class="level3">

</div>

<h4>Local</h4>
<div class="level4">

<p>
Local variables can be used throughout the same script file.
</p>
<pre class="code c++"><span class="kw4">void</span> SetLocalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">int</span> alVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddLocalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">int</span> alVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">int</span> GetLocalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>



<pre class="code c++"><span class="kw4">void</span> SetLocalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddLocalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetLocalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>



<pre class="code c++"><span class="kw4">void</span> SetLocalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">const</span> string<span class="sy0">&</span> asVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddLocalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asVal<span class="br0">)</span><span class="sy0">;</span>
string<span class="sy0">&</span> GetLocalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




</div>

<h4>Global</h4>
<div class="level4">

<p>
Global variables can be used throughout several maps and can be accessed by several script files.
</p>
<pre class="code c++"><span class="kw4">void</span> SetGlobalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">int</span> alVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddGlobalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">int</span> alVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">int</span> GetGlobalVarInt<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>



<pre class="code c++"><span class="kw4">void</span> SetGlobalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddGlobalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetGlobalVarFloat<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>



<pre class="code c++"><span class="kw4">void</span> SetGlobalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">const</span> string<span class="sy0">&</span> asVal<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddGlobalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asVal<span class="br0">)</span><span class="sy0">;</span>
string<span class="sy0">&</span> GetGlobalVarString<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




</div>

<h3>Particle Systems</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> PreloadParticleSystem<span class="br0">(</span>string<span class="sy0">&</span> asPSFile<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Preloads a particle system. Extension: .ps
</p>
<pre class="code c++"><span class="kw4">void</span> CreateParticleSystemAtEntity<span class="br0">(</span>string<span class="sy0">&</span> asPSName<span class="sy0">,</span> string<span class="sy0">&</span> asPSFile<span class="sy0">,</span> string<span class="sy0">&</span> asEntity<span class="sy0">,</span> bool abSavePS<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Creates a particle system on an entity.
</p>

<p>
<em>asPSName </em>- internal name<br/>

<em>asPSFile </em>- the particle system to use + extension .ps<br/>

<em>asEntity </em>- the entity to create the particle system at<br/>

<em>abSavePS </em>- determines whether a particle system should "remember" its shown/hidden state, so that this state can be restored when the player revisits the level
</p>
<pre class="code c++"><span class="kw4">void</span> CreateParticleSystemAtEntityExt<span class="br0">(</span>string<span class="sy0">&</span> asPSName<span class="sy0">,</span> string<span class="sy0">&</span> asPSFile<span class="sy0">,</span> string<span class="sy0">&</span> asEntity<span class="sy0">,</span> bool abSavePS<span class="sy0">,</span>
<span class="kw4">float</span> afR<span class="sy0">,</span> <span class="kw4">float</span> afG<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="sy0">,</span> <span class="kw4">float</span> afA<span class="sy0">,</span> bool abFadeAtDistance<span class="sy0">,</span> <span class="kw4">float</span> afFadeMinEnd<span class="sy0">,</span> <span class="kw4">float</span> afFadeMinStart<span class="sy0">,</span>
<span class="kw4">float</span> afFadeMaxStart<span class="sy0">,</span> <span class="kw4">float</span> afFadeMaxEnd<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Creates a particle system on an entity, extended method with more options.
</p>

<p>
<em>asPSName </em>- internal name<br/>

<em>asPSFile </em>- the particle system to use + extension .ps<br/>

<em>asEntity </em>- the entity to create the particle system at<br/>

<em>abSavePS </em>- determines whether a particle system should "remember" its shown/hidden state, so that this state can be restored when the player revisits the level<br/>

<em>afR </em>- red value<br/>

<em>afG </em>- green value<br/>

<em>afB </em>- blue value<br/>

<em>afA </em>- alpha value<br/>

<em>abFadeAtDistance </em>- determines whether a particle system fades from a certain distance on<br/>

<em>afFadeMinEnd </em>- minimum distance at which the particle system stops fading<br/>

<em>afFadeMinStart </em>- minimum distance at which the particle system starts fading<br/>

<em>afFadeMaxStart </em>- maximum distance at which the particle system starts fading<br/>

<em>afFadeMaxEnd </em>- maximum distance at which the particle system stops fading
</p>
<pre class="code c++"><span class="kw4">void</span> DestroyParticleSystem<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Destroys a particle system.
</p>

</div>

<h3>Sounds & Music</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> PreloadSound<span class="br0">(</span>string<span class="sy0">&</span> asSoundFile<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Preloads a sound. Extension: .snt
</p>
<pre class="code c++"><span class="kw4">void</span> PlaySoundAtEntity<span class="br0">(</span>string<span class="sy0">&</span> asSoundName<span class="sy0">,</span> string<span class="sy0">&</span> asSoundFile<span class="sy0">,</span> string<span class="sy0">&</span> asEntity<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">,</span> bool abSaveSound<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Creates a sound on an entity.
</p>

<p>
<em>asSoundName </em>- internal name<br/>

<em>asSoundFile </em>- the sound to use + extension .snt<br/>

<em>asEntity </em>- the entity to create the sound at, can be "Player"<br/>

<em>afFadeTime </em>- time in seconds the sound needs to fade. Avoids enemies hearing the sound if afFadeTime is at least 0.1f<br/>

<em>abSaveSound </em>- if <code>true</code>, a looping sound will "remember" its playback state (currently playing/stopped), and that state will be restored the next time the level is entered. If <code>true</code>, the sound is never attached to the entity! Note that saving should only be used on <em>looping sounds</em>!
</p>
<pre class="code c++"><span class="kw4">void</span> FadeInSound<span class="br0">(</span>string<span class="sy0">&</span> asSoundName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">,</span> bool abPlayStart<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades in a sound.
</p>

<p>
<em>asSoundName </em>- internal name<br/>

<em>afFadeTime </em>- time in seconds<br/>

<em>abPlayStart </em>- ?
</p>
<pre class="code c++"><span class="kw4">void</span> StopSound<span class="br0">(</span>string<span class="sy0">&</span> asSoundName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades out a sound.
</p>

<p>
<em>asSoundName </em>- internal name<br/>

<em>afFadeTime </em>- time in seconds, use 0 to immediatly stop the sound
</p>
<pre class="code c++"><span class="kw4">void</span> PlayMusic<span class="br0">(</span>string<span class="sy0">&</span> asMusicFile<span class="sy0">,</span> bool abLoop<span class="sy0">,</span> <span class="kw4">float</span> afVolume<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="sy0">,</span> bool abResume<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Plays music.
</p>

<p>
<em>asMusicFile </em>- the music to play + extension .ogg<br/>

<em>abLoop </em>- determines whether a music track should loop<br/>

<em>afVolume </em>- volume of the music<br/>

<em>afFadeTime </em>- time in seconds until music reaches full volume<br/>

<em>alPrio </em>- priority of the music. Note that only the music with the highest priority can be heard! 0 - lowest, 1 - higher, etc.<br/>

<em>abResume</em> - if <code>true</code>, playback will be continued from where the track stopped after the call to StopMusic(); if <code>false</code>, the track will be restarted.
</p>
<pre class="code c++"><span class="kw4">void</span> StopMusic<span class="br0">(</span><span class="kw4">float</span> afFadeTime<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Stops music.
</p>

<p>
<em>afFadeTime </em>- time in seconds until music stops<br/>

<em>alPrio </em>- the priority of the music that should stop
</p>
<pre class="code c++"><span class="kw4">void</span> FadeGlobalSoundVolume<span class="br0">(</span><span class="kw4">float</span> afDestVolume<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Influences the global sound volume, that means everything you can hear <b>from the world</b>. This does not affect music of GUI sounds.
</p>

<p>
<em>afDestVolume </em>- desired volume<br/>

<em>afTime </em>- time in seconds until volume reaches desired volume
</p>
<pre class="code c++"><span class="kw4">void</span> FadeGlobalSoundSpeed<span class="br0">(</span><span class="kw4">float</span> afDestSpeed<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Influences the global sound speed.
</p>

<p>
<em>afDestSpeed </em>- desired speed<br/>

<em>afTime </em>- time in seconds until volume reaches desired speed
</p>

</div>

<h3>Lights</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> SetLightVisible<span class="br0">(</span>string<span class="sy0">&</span> asLightName<span class="sy0">,</span> bool abVisible<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables/disables lights.
</p>

<p>
<em>asLightName </em>- internal name<br/>

<em>abVisible </em>- determines the state of the light
</p>
<pre class="code c++"><span class="kw4">void</span> FadeLightTo<span class="br0">(</span>string<span class="sy0">&</span> asLightName<span class="sy0">,</span> <span class="kw4">float</span> afR<span class="sy0">,</span> <span class="kw4">float</span> afG<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="sy0">,</span> <span class="kw4">float</span> afA<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>
Changes the properties of a light.
</p>

<p>
<em>asLightName </em>- internal name<br/>

<em>afR </em>- red value<br/>

<em>afG </em>- green value<br/>

<em>afB </em>- blue value<br/>

<em>afA </em>- alpha value<br/>

<em>afRadius </em>- radius of the light. -1 means keeping the radius<br/>

<em>afTime </em>- time in seconds until change is done
</p>
<pre class="code c++"><span class="kw4">void</span> SetLightFlickerActive<span class="br0">(</span>string<span class="sy0">&</span> asLightName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Activates flickering on a light.
</p>

</div>

<h2>Game scripts</h2>
<div class="level2">

</div>

<h3>General</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> StartCredits<span class="br0">(</span>string<span class="sy0">&</span> asMusic<span class="sy0">,</span> bool abLoopMusic<span class="sy0">,</span> string<span class="sy0">&</span> asTextCat<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="sy0">,</span> <span class="kw4">int</span> alEndNum<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Starts the end credits screen.
</p>

<p>
<em>asMusic </em>- the music to play (including .ogg)<br/>

<em>abLoopMusic </em>- determines whether the music should loop<br/>

<em>asTextCat </em>- the category to be used in the .lang file<br/>

<em>asTextEntry </em>- the entry in the .lang file<br/>

<em>alEndNum </em>- Amnesia has 3 different endings and displays a code at the bottom. Determines which code is displayed. 0-2 will display codes, any other integer will not.
</p>
<pre class="code c++"><span class="kw4">void</span> StartDemoEnd<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Starts the end images that are used in the demo, images are named "demo_end01.jpg", increase the number for each image you want to use. (NEEDS VERIFICATION)
</p>
<pre class="code c++"><span class="kw4">void</span> AutoSave<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Save the game to the auto save.
</p>
<pre class="code c++"><span class="kw4">void</span> CheckPoint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asStartPos<span class="sy0">,</span> string<span class="sy0">&</span> asCallback<span class="sy0">,</span> string<span class="sy0">&</span> asDeathHintCat<span class="sy0">,</span> string<span class="sy0">&</span> asDeathHintEntry<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets a checkpoint at which the player will respawn in case he dies.<br/>

Callback syntax: <b>void MyFunc(string &in asName, int alCount)</b> <br/>

Count is 0 on the first checkpoint load!
</p>

<p>
<em>asName </em>- the internal name<br/>

<em>asStartPos </em>- the name of the StartPos in the editor<br/>

<em>asCallback </em>- the function to call when the player dies/respawns<br/>

<em>asDeathHintCat </em>- the category of the death hint message to be used in the .lang file<br/>

<em>asDeathHintEntry </em>- the entry in the .lang file
</p>
<pre class="code c++"><span class="kw4">void</span> ChangeMap<span class="br0">(</span>string<span class="sy0">&</span> asMapName<span class="sy0">,</span> string<span class="sy0">&</span> asStartPos<span class="sy0">,</span> string<span class="sy0">&</span> asStartSound<span class="sy0">,</span> string<span class="sy0">&</span> asEndSound<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Immediatly loads another map.
</p>

<p>
<em>asMapName </em>- the file to load<br/>

<em>asStartPos </em>- the name of the StartPos on the next map<br/>

<em>asStartSound </em>- the sound that is played when the change starts<br/>

<em>asEndSound </em>- the sound that is played when the new map is loaded
</p>
<pre class="code c++"><span class="kw4">void</span> ClearSavedMaps<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Clears the "history" of the save, useful to do when you know the player will not be able to go back anymore. Makes the next save much smaller in size.
</p>
<pre class="code c++"><span class="kw4">void</span> CreateDataCache<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> DestroyDataCache<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
This caches all current textures and models and they are not released until destroy is called. If there is already cached data it is destroyed.
</p>
<pre class="code c++"><span class="kw4">void</span> SetMapDisplayNameEntry<span class="br0">(</span>string<span class="sy0">&</span> asNameEntry<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the map name shown in save file names. If none is set NULL is assumed.
</p>

<p>
<em>asNameEntry </em>- the entry to display, category must be "Levels"!
</p>
<pre class="code c++"><span class="kw4">void</span> SetSkyBoxActive<span class="br0">(</span>bool abActive<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables&lt;nowiki>&#92;&lt;/nowiki>Disables the skybox.
</p>
<pre class="code c++"><span class="kw4">void</span> SetSkyBoxTexture<span class="br0">(</span>string<span class="sy0">&</span> asTexture<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the texture of the skybox.
</p>
<pre class="code c++"><span class="kw4">void</span> SetSkyBoxColor<span class="br0">(</span><span class="kw4">float</span> afR<span class="sy0">,</span> <span class="kw4">float</span> afG<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="sy0">,</span> <span class="kw4">float</span> afA<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<em>afR </em>- red value<br/>

<em>afG </em>- green value<br/>

<em>afB </em>- blue value<br/>

<em>afA </em>- alpha value
</p>
<pre class="code c++"><span class="kw4">void</span> SetFogActive<span class="br0">(</span>bool abActive<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables&lt;nowiki>&#92;&lt;/nowiki>Disables the global fog.
</p>
<pre class="code c++"><span class="kw4">void</span> SetFogColor<span class="br0">(</span><span class="kw4">float</span> afR<span class="sy0">,</span> <span class="kw4">float</span> afG<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="sy0">,</span> <span class="kw4">float</span> afA<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<em>afR </em>- red value<br/>

<em>afG </em>- green value<br/>

<em>afB </em>- blue value<br/>

<em>afA </em>- alpha value
</p>
<pre class="code c++"><span class="kw4">void</span> SetFogProperties<span class="br0">(</span><span class="kw4">float</span> afStart<span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="sy0">,</span> <span class="kw4">float</span> afFalloffExp<span class="sy0">,</span> bool abCulling<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<em>afStart </em>- how many meters from the camera should the fog begin<br/>

<em>afEnd </em>- how many meters from the camera should the fog reach full thickness<br/>

<em>afFalloffExp </em>- the amount by which the thinkness increases<br/>

<em>abCulling </em>- whether occlusion culling is active for the fog; this prevents objects behind the fog from being loaded
</p>
<pre class="code c++"><span class="kw4">void</span> SetupLoadScreen<span class="br0">(</span>string<span class="sy0">&</span>asTextCat<span class="sy0">,</span> string<span class="sy0">&</span>asTextEntry<span class="sy0">,</span> <span class="kw4">int</span> alRandomNum<span class="sy0">,</span> string<span class="sy0">&</span>asImageFile<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Determines which loading screen will be shown when changing maps.
</p>

<p>
<em>asTextCat </em>- the category of the loading text in the .lang file to be shown on the loading screen<br/>

<em>asTextEntry </em>- the entry in the .lang file<br/>

<em>alRandomNum </em>- if greater 1, then it will randomize between 1 and alRandom for each LoadScreen giving entry the suffix XX (eg 01). If < =1 then no suffix is added<br/>

<em>asImageFile </em>- the image to be shown (optional)
</p>

</div>

<h3>Game Timer</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> AddTimer<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> string<span class="sy0">&</span> asFunction<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Creates a timer which calls a function when it expires.<br/>

Callback syntax: <b>void MyFunc(string &in asTimer)</b>
</p>

<p>
<em>asName </em>- the name of the timer<br/>

<em>afTime </em>- time in seconds<br/>

<em>asFunction </em>- the function to call
</p>
<pre class="code c++"><span class="kw4">void</span> RemoveTimer<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes a timer, no matter how much time is left.
</p>
<pre class="code c++"><span class="kw4">float</span> GetTimerTimeLeft<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Returns the time left on a timer.
</p>

</div>

<h3>Screen Effects</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> FadeOut<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades the screen to black.
</p>

<p>
<em>afTime </em>- time in seconds until the screen is completly black
</p>
<pre class="code c++"><span class="kw4">void</span> FadeIn<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades the screen back to normal.
</p>

<p>
<em>afTime </em>- time in seconds until the screen back to normal
</p>
<pre class="code c++"><span class="kw4">void</span> FadeImageTrailTo<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Applies the image trail effect to the screen.
</p>

<p>
<em>afAmount </em>- intensity (default: 0)<br/>

<em>afSpeed </em>- time in seconds until full effect
</p>
<pre class="code c++"><span class="kw4">void</span> FadeSepiaColorTo<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Makes the screen go dark red.
</p>

<p>
<em>afAmount </em>- intensity (default: 0)<br/>

<em>afSpeed </em>- time in seconds until full effect
</p>
<pre class="code c++"><span class="kw4">void</span> FadeRadialBlurTo<span class="br0">(</span><span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Applies radial blur effects to the screen.
</p>

<p>
<em>afSize </em>- intensity (default: 0)<br/>

<em>afSpeed </em>- time in seconds until full effect
</p>
<pre class="code c++"><span class="kw4">void</span> SetRadialBlurStartDist<span class="br0">(</span><span class="kw4">float</span> afStartDist<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Determines at which distance the radial blur effects appear.
</p>

<p>
<em>afStartDist </em>- the distance at which the effect starts
</p>
<pre class="code c++"><span class="kw4">void</span> StartEffectFlash<span class="br0">(</span><span class="kw4">float</span> afFadeIn<span class="sy0">,</span> <span class="kw4">float</span> afWhite<span class="sy0">,</span> <span class="kw4">float</span> afFadeOut<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades the screen to white.
</p>

<p>
<em>afFadeIn </em>- time in seconds until screen is white<br/>

<em>afWhite </em>- determines to which percentage the screen fades to white (1.0 = completly white)<br/>

<em>afFadeOut </em>- time in seconds until screen is back to normal again
</p>
<pre class="code c++"><span class="kw4">void</span> StartEffectEmotionFlash<span class="br0">(</span>string<span class="sy0">&</span> asTextCat<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="sy0">,</span> string<span class="sy0">&</span> asSound<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Fades the screen to white and shows a text message.
</p>

<p>
<em>asTextCat </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the text entry in the .lang file<br/>

<em>asSound </em>- the sound to play while fading
</p>
<pre class="code c++"><span class="kw4">void</span> AddEffectVoice<span class="br0">(</span>string<span class="sy0">&</span> asVoiceFile<span class="sy0">,</span> string<span class="sy0">&</span> asEffectFile<span class="sy0">,</span> string<span class="sy0">&</span> asTextCat<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="sy0">,</span>
bool abUsePosition<span class="sy0">,</span> string<span class="sy0">&</span> asPosEntity<span class="sy0">,</span> <span class="kw4">float</span> afMinDistance<span class="sy0">,</span> <span class="kw4">float</span> afMaxDistance<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
This adds a voice and an effect to be played. It is okay to call this many times in order to play many voices in a row. The EffectVoiceOverCallback is not called until ALL voices have finished.
</p>

<p>
<em>asVoiceFile </em>- the voice to play<br/>

<em>asEffectFile </em>- the effect to play<br/>

<em>asTextCat </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the text entry in the .lang file<br/>

<em>abUsePosition </em>- plays using 3D from the entity, or without 3D<br/>

<em>asPosEntity </em>- the entity at which the effect appears<br/>

<em>afMinDistance </em>- minimum distance to see the effect<br/>

<em>afMaxDistance </em>- maximum distance to see the effect
</p>
<pre class="code c++"><span class="kw4">void</span> StopAllEffectVoices<span class="br0">(</span><span class="kw4">float</span> afFadeOutTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Stops all voices and calls the EffectVoiceOverCallback.
</p>
<pre class="code c++">bool GetEffectVoiceActive<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether EffectVoices are still active.
</p>
<pre class="code c++"><span class="kw4">void</span> SetEffectVoiceOverCallback<span class="br0">(</span>string<span class="sy0">&</span> asFunc<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the function to be called when the EffectVoices are finished.<br/>

Callback syntax: <b>void MyFunc()</b>
</p>
<pre class="code c++">bool GetFlashbackIsActive<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether a flashback is still in effect.
</p>
<pre class="code c++"><span class="kw4">void</span> StartPlayerSpawnPS<span class="br0">(</span>string<span class="sy0">&</span> asSPSFile<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> StopPlayerSpawnPS<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Spawns particle systems around the player. It uses the settings from <code>.sps</code> files which are located in the <code>/misc</code> folder.<br/>

Can be used e.g. to continuously spawn fog effects around the player.
</p>
<pre class="code c++"><span class="kw4">void</span> PlayGuiSound<span class="br0">(</span>string<span class="sy0">&</span> asSoundFile<span class="sy0">,</span> <span class="kw4">float</span> afVolume<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Plays a sound, not using 3D.
</p>

<p>
<em>asSoundFile </em>- the sound to play (extension is .snt)<br/>

<em>afVolume </em>- the volume of the sound
</p>
<pre class="code c++"><span class="kw4">void</span> StartScreenShake<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Shakes the screen.
</p>

<p>
<em>afAmount </em>- intensity of the shake<br/>

<em>afTime </em>- duration of the shake<br/>

<em>afFadeInTime </em>- time in seconds until full intensity is reached<br/>

<em>afFadeOutTime </em>- time until screen is back to normal
</p>
<pre class="code c++"><span class="kw4">void</span> SetInDarknessEffectsActive<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables the sanity drain and night vision effects while in the darkness.
</p>

<p>
<em>bool abX</em> - Enable/disable effects.
</p>

</div>

<h3>Insanity</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> SetInsanitySetEnabled<span class="br0">(</span>string<span class="sy0">&</span> asSet<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Determines which InsanitySets are enabled.
</p>

<p>
<em>asSet </em>- the set<br/>

<em>abX </em>- enabled or not
</p>
<pre class="code c++"><span class="kw4">void</span> StartInsanityEvent<span class="br0">(</span>string <span class="sy0">&</span>in asEventName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Starts a specified insanity event.
</p>

<p>
<em>asEventName </em>- Insanity event to play.
</p>
<pre class="code c++"><span class="kw4">void</span> StartRandomInsanityEvent<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Starts a random insanity event from the available sets.
</p>
<pre class="code c++"><span class="kw4">void</span> StopCurrentInsanityEvent<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Stops the currently playing insanity event.
</p>
<pre class="code c++">bool InsanityEventIsActive<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether an insanity event is currently in effect.
</p>

</div>

<h3>Player</h3>
<div class="level3">

<p>
Note that the player's maximum health and sanity is 100.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerActive<span class="br0">(</span>bool abActive<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enabled/Disable player controlled movement.
</p>
<pre class="code c++"><span class="kw4">void</span> ChangePlayerStateToNormal<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets certain effects back to normal. It can for example make the player drop an item.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerCrouching<span class="br0">(</span>bool abCrouch<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Forces the player to crouch.
</p>
<pre class="code c++"><span class="kw4">void</span> AddPlayerBodyForce<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="sy0">,</span> <span class="kw4">float</span> afZ<span class="sy0">,</span> bool abUseLocalCoords<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Pushes the player into a certain direction. Note that you need values above ~2000 to see any effects.
</p>

<p>
<em>afX </em>- amount along the X-axis<br/>

<em>afY </em>- amount along the Y-axis<br/>

<em>afZ </em>- amount along the Z-axis<br/>

<em>abUseLocalCoords </em>- If true, axes are based on where the player is facing, not the world.
</p>
<pre class="code c++"><span class="kw4">void</span> ShowPlayerCrossHairIcons<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables/Disables the icons when a player has something in focus.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerSanity<span class="br0">(</span><span class="kw4">float</span> afSanity<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddPlayerSanity<span class="br0">(</span><span class="kw4">float</span> afSanity<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerSanity<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Modifies/returns the sanity of the player.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerHealth<span class="br0">(</span><span class="kw4">float</span> afHealth<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddPlayerHealth<span class="br0">(</span><span class="kw4">float</span> afHealth<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerHealth<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Modifies/returns the health of the player.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerLampOil<span class="br0">(</span><span class="kw4">float</span> afOil<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> AddPlayerLampOil<span class="br0">(</span><span class="kw4">float</span> afOil<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerLampOil<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Modifies/returns the lamp oil of the player.
</p>
<pre class="code c++"><span class="kw4">float</span> GetPlayerSpeed<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerYSpeed<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Returns the current speed of the player.
</p>
<pre class="code c++"><span class="kw4">void</span> SetSanityDrainDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables/Disables sanity drain from darkness, monsters, etc.
</p>
<pre class="code c++"><span class="kw4">void</span> GiveSanityBoost<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> GiveSanityBoostSmall<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Boosts the player's sanity by a fixed amount.
</p>
<pre class="code c++"><span class="kw4">void</span> GiveSanityDamage<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> bool abUseEffect<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Reduces the sanity of the player.
</p>

<p>
<em>afAmount </em>- amount of sanity damage done<br/>

<em>abUseEffect </em>- determines whether an effect is played when the sanity damage is dealt
</p>
<pre class="code c++"><span class="kw4">void</span> GivePlayerDamage<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> string<span class="sy0">&</span> asType<span class="sy0">,</span> bool abSpinHead<span class="sy0">,</span> bool abLethal<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Reduces the health of the player.
</p>

<p>
<em>afAmount </em>- amount of damage done to health<br/>

<em>asType </em>- plays a certain effect on the screen when the damage is dealt (BloodSplat, Claws or Slash)<br/>

<em>abSpinHead </em>- changes the camera view when damage is dealt<br/>

<em>abLethal </em>- set to true if player can die from given damage
</p>
<pre class="code c++"><span class="kw4">void</span> FadePlayerFOVMulTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Changes the field of view of the player. A shorter FOV will create a zoom effect.
</p>

<p>
<em>afX </em>- multiplier of default FOV (1 is default)<br/>

<em>afSpeed </em>- the speed of change between FOV's
</p>
<pre class="code c++"><span class="kw4">void</span> FadePlayerAspectMulTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Changes the aspect ratio of the player. Basically stretches or narrows the screen horizontally.
</p>

<p>
<em>afX </em>- multiplier of default aspect (default is 1)<br/>

<em>afSpeed </em>- the speed of change between FOV's
</p>
<pre class="code c++"><span class="kw4">void</span> FadePlayerRollTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeedMul<span class="sy0">,</span> <span class="kw4">float</span> afMaxSpeed<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Rotates the position of the camera on the player's body.
</p>

<p>
<em>afX </em>- angle of rotation of head, positive being counter-clockwise<br/>

<em>afSpeedMul </em>- speed (possibly acceleration) multiplier of the rotation (default 1, which is really slow)<br/>

<em>afMaxSpeed </em>- maximum speed of rotation
</p>
<pre class="code c++"><span class="kw4">void</span> MovePlayerHeadPos<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="sy0">,</span> <span class="kw4">float</span> afZ<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="sy0">,</span> <span class="kw4">float</span> afSlowDownDist<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Changes the position of the camera on the player's body.
</p>

<p>
<em>afX </em>- amount along the X-axis<br/>

<em>afY </em>- amount along the Y-axis<br/>

<em>afZ </em>- amount along the Z-axis<br/>

<em>afSpeed </em>- speed at which the change happens<br/>

<em>afSlowDownDist </em>- distance at which to start slowing down (prevents the head from abruptly stopping)
</p>
<pre class="code c++"><span class="kw4">void</span> StartPlayerLookAt<span class="br0">(</span>string<span class="sy0">&</span> asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afSpeedMul<span class="sy0">,</span> <span class="kw4">float</span> afMaxSpeed<span class="sy0">,</span> string<span class="sy0">&</span> asAtTargetCallback<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> StopPlayerLookAt<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Forces the player to look at a certain entity until StopPlayerLookAt is used.
</p>

<p>
<em>asEntityName </em>- the entity to look at<br/>

<em>afSpeedMul </em>- how fast should the player look at the entity<br/>

<em>afMaxSpeed </em>- maximum speed allowed<br/>

<em>asAtTargetCallback </em>- function to call when player looks at target
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerMoveSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> SetPlayerRunSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> SetPlayerLookSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Changes the player's move/run/look speed. Default is 1.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerJumpForceMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Changes the player's jump multiplier. Higher values = higher jumps. Default is 1.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerJumpDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> SetPlayerCrouchDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables/Disables the player's ability to jump/crouch.
</p>
<pre class="code c++"><span class="kw4">void</span> TeleportPlayer<span class="br0">(</span>string<span class="sy0">&</span> asStartPosName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Instantly teleports the player to the target StartPos.
</p>
<pre class="code c++"><span class="kw4">void</span> SetLanternActive<span class="br0">(</span>bool abX<span class="sy0">,</span> bool abUseEffects<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Makes the player use his lantern.
</p>
<pre class="code c++">bool GetLanternActive<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether the player currently uses his lantern.
</p>
<pre class="code c++"><span class="kw4">void</span> SetLanternDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Enables/Disables the player's ability to use his lantern.
</p>
<pre class="code c++"><span class="kw4">void</span> SetLanternLitCallback<span class="br0">(</span>string<span class="sy0">&</span> asCallback<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the function to call when the player uses his lantern.<br/>

Callback syntax: <b>MyFunc(bool abLit)</b>
</p>
<pre class="code c++"><span class="kw4">void</span> SetMessage<span class="br0">(</span>string<span class="sy0">&</span> asTextCategory<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Displays a message on the screen.
</p>

<p>
<em>asTextCategory </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the entry in the .lang file<br/>

<em>afTime </em>- determines how long the message is displayed. If time is < =0 then the life time is calculated based on string length.
</p>
<pre class="code c++"><span class="kw4">void</span> SetDeathHint<span class="br0">(</span>string<span class="sy0">&</span> asTextCategory<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the message that appears when the player dies.
</p>

<p>
<em>asTextCategory </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the entry in the .lang file
</p>
<pre class="code c++"><span class="kw4">void</span> DisableDeathStartSound<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Disables the death sound when the player dies. This must be called directly before player is killed! The variable as soon as player dies too.
</p>
<pre class="code">void MovePlayerForward(float afAmount)



</pre><p> </p>




<p>
"REQUIRES THE 1.2 PATCH: JUSTINE" Moves the player forward. It needs to be called in a timer that updates 60 times / second.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerFallDamageDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables the player's ability to take fall damage.
</p>
<pre class="code c++"><span class="kw4">void</span> SetPlayerPos<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="sy0">,</span> <span class="kw4">float</span> afZ<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Sets the player's position within the level.
</p>

<p>
<em>afX</em> - X co-ordinate position.<br/>

<em>afY</em> - Y co-ordinate position.<br/>

<em>afZ</em> - Z co-ordinate position.
</p>
<pre class="code c++"><span class="kw4">float</span> GetPlayerPosX<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerPosY<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetPlayerPosZ<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the player's position within the level on the specified axis.
</p>

</div>

<h3>Journal</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> AddNote<span class="br0">(</span>string<span class="sy0">&</span> asNameAndTextEntry<span class="sy0">,</span> string<span class="sy0">&</span> asImage<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds a note to the player's journal.
</p>

<p>
<em>asNameAndTextEntry </em>- entries in the .lang file. Must end with _Name and _Text and be in category "Journal"!<br/>

<em>asImage </em>- the background image to be used
</p>
<pre class="code c++"><span class="kw4">void</span> AddDiary<span class="br0">(</span>string<span class="sy0">&</span> asNameAndTextEntry<span class="sy0">,</span> string<span class="sy0">&</span> asImage<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds a diary to the player's journal.
</p>

<p>
<em>asNameAndTextEntry </em>- entries in the .lang file. Must end with _NameX and _TextY whereas X and Y are numbers of the parts (_Name1: first diary, _Text1: first page) and be in category "Journal"!<br/>

<em>asImage </em>- the background image to be used
</p>
<pre class="code c++"><span class="kw4">void</span> ReturnOpenJournal<span class="br0">(</span>bool abOpenJournal<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Only called in the pickup diary callback! If true the journal displays the entry else not.
</p>

</div>

<h3>Quests</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> AddQuest<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asNameAndTextEntry<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds a quest to the player's journal.
</p>

<p>
<em>asName </em>- the internal name to be used<br/>

<em>asNameAndTextEntry </em>- entry in the .lang file. Must start with "Quest_&lt;texthere>_Text”, and be in category “Journal”!
</p>
<pre class="code c++"><span class="kw4">void</span> CompleteQuest<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asNameAndTextEntry<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Completes a quest.
</p>

<p>
<em>asName </em>- the internal name of the quest<br/>

<em>asNameAndTextEntry </em>- entry in the .lang file. Must start with " Quest_&lt;texthere>_Text ”, and be in category “Journal”!
</p>
<pre class="code c++">bool QuestIsCompleted<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>
bool QuestIsAdded<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether a quest is completed/added.
</p>
<pre class="code c++"><span class="kw4">void</span> SetNumberOfQuestsInMap<span class="br0">(</span><span class="kw4">int</span> alNumberOfQuests<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Sets the number of quests in the map.
</p>

<p>
<em>alNumberOfQuests </em>- Amount of Quests
</p>
<pre class="code c++"><span class="kw4">void</span> GiveHint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asMessageCat<span class="sy0">,</span> string<span class="sy0">&</span> asMessageEntry<span class="sy0">,</span> <span class="kw4">float</span> afTimeShown<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Displays a hint on the player's screen.
</p>

<p>
<em>asName </em>- the internal name<br/>

<em>asMessageCat </em>- the category in the .lang file<br/>

<em>asMessageEntry </em>- the entry in the .lang file<br/>

<em>afTimeShown </em>- time in seconds until the message disappears. If time is &lt;= 0 then the life time is calculated based on string length.
</p>
<pre class="code c++"><span class="kw4">void</span> RemoveHint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> BlockHint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">void</span> UnBlockHint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes&lt;nowiki>&#92;&lt;/nowiki>Blocks&lt;nowiki>&#92;&lt;/nowiki>Unblocks a hint.
</p>

</div>

<h3>Inventory</h3>
<div class="level3">
<pre class="code c++"><span class="kw4">void</span> ExitInventory<span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Exits the inventory by force.
</p>
<pre class="code c++"><span class="kw4">void</span> SetInventoryDisabled<span class="br0">(</span>bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Disables the player's ability to open his inventory.
</p>
<pre class="code c++"><span class="kw4">void</span> SetInventoryMessage<span class="br0">(</span>string<span class="sy0">&</span> asTextCategory<span class="sy0">,</span> string<span class="sy0">&</span> asTextEntry<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds a message at the bottom of the inventory screen.
</p>

<p>
<em>asTextCategory </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the entry in the .lang file<br/>

<em>afTime </em>- time in seconds until the message disappears. If life time is &lt;= 0 then the life time is calculated based on string length.
</p>
<pre class="code c++"><span class="kw4">void</span> GiveItem<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asType<span class="sy0">,</span> string<span class="sy0">&</span> asSubTypeName<span class="sy0">,</span> string<span class="sy0">&</span> asImageName<span class="sy0">,</span> <span class="kw4">float</span> afAmount<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds an item to the inventory of the player. Note that the item does not have to exist as entity in the world to be able to do this.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asType </em>- item to give<br/>

<em>asSubTypeName </em>- item name for .lang file<br/>

<em>asImageName </em>- For exemple: void GiveItem(string& asName, string& asType, "chemical_container_full", <span style = "color:rgb(255,0,0)"><span style = "font-size:12pt:normal"><span style = "font-family:auto"><span style = "background-color:inherit">“chemical_container_full.tga”</span></span></span></span>    , float afAmount); The image is from <<em>nowiki></em> <<em>nowiki></em> <<em>nowiki>&lt;nowiki>&#92;&lt;/nowiki></em> <<em>/nowiki></em> <<em>/nowiki></em> <<em>/nowiki></em> graphics&lt;nowiki>&#92;&lt;/nowiki>Item&lt;nowiki>&#92;&lt;/nowiki>chemical_container_full.tga : is the image which will appear in Inventory - <a href="http://img155.imageshack.us/img155/6871/20806785.jpg" class="urlextern" title="http://img155.imageshack.us/img155/6871/20806785.jpg"  rel="nofollow">img155.imageshack.us/img155/6871/20806785.jpg</a>
</p>

<p>
<em>afAmount </em>- amount to give
</p>
<pre class="code c++"><span class="kw4">void</span> RemoveItem<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes an item from the player's inventory.
</p>
<pre class="code c++">bool HasItem<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether the player has an item in his inventory.
</p>
<pre class="code c++"><span class="kw4">void</span> GiveItemFromFile<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asFileName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Adds a single item to the player's inventory. This is meant to be used for debug mostly as it creates the actual item and then destroys it.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asFileName </em>- item to give + extension (.ent)
</p>
<pre class="code c++"><span class="kw4">void</span> AddCombineCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asItemA<span class="sy0">,</span> string<span class="sy0">&</span> asItemB<span class="sy0">,</span> string<span class="sy0">&</span> asFunction<span class="sy0">,</span> bool abAutoRemove<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Allows the player to combine items in his inventory.<br/>

Callback syntax: <b>void MyFunc(string &in asItemA, string &in asItemB)</b>
</p>

<p>
<em>asName </em>- internal name for the callback<br/>

<em>asItemA </em>- internal name of first item<br/>

<em>asItemB </em>- internal name of second item<br/>

<em>asFunction </em>- the function to call<br/>

<em>abAutoRemove </em>- determines whether the callback should be removed when the items are combined
</p>
<pre class="code c++"><span class="kw4">void</span> RemoveCombineCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes a combine callback.<br/>

<em>asName</em> - the internal name of the callback to be removed (as specified in AddCombineCallback)
</p>
<pre class="code c++"><span class="kw4">void</span> AddUseItemCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asItem<span class="sy0">,</span> string<span class="sy0">&</span> asEntity<span class="sy0">,</span> string<span class="sy0">&</span> asFunction<span class="sy0">,</span> bool abAutoDestroy<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Allows the player to use items on the world.<br/>

Callback syntax: <b>void MyFunc(string &in asItem, string &in asEntity)</b>
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asItem </em>- internal name of the item<br/>

<em>asEntity </em>- entity to be able to use the item on<br/>

<em>asFunction </em>- function to call<br/>

<em>abAutoDestroy </em>- determines whether the item is destroyed when used
</p>
<pre class="code c++"><span class="kw4">void</span> RemoveUseItemCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes an item callback.
</p>

</div>

<h3>Entities</h3>
<div class="level3">

</div>

<h4>General</h4>
<div class="level4">
<pre class="code c"><span class="kw4">void</span> SetEntityActive<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> bool abActive<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Activates/deactivates an entity.
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityVisible<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abVisible<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Activates/deactivates an entity's visual mesh. The collision body remains.
</p>

<p>
<em>asName</em> - Name of the entity.<br/>

<em>abActive</em> - Activate/deactivate mesh.
</p>
<pre class="code c">bool GetEntityExists<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether an entity exists.
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityCustomFocusCrossHair<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asCrossHair<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Changes the crosshair that is used when focusing an entity.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asCrossHair </em>- desired crosshair, can be: Default (uses default), Grab, Push, Ignite, Pick, LevelDoor, Ladder
</p>
<pre class="code c"><span class="kw4">void</span> CreateEntityAtArea<span class="br0">(</span>string<span class="sy0">&</span> asEntityName<span class="sy0">,</span> string<span class="sy0">&</span> asEntityFile<span class="sy0">,</span> string<span class="sy0">&</span> asAreaName<span class="sy0">,</span> bool abFullGameSave<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Creates an entity at an area. When creating an enemy though, it cannot chase properly along PathNodes(using for example ShowEnemyPlayerPosition).
</p>

<p>
<em>asEntityName </em>- internal name<br/>

<em>asEntityFile </em>- entity to be used extension .ent<br/>

<em>asAreaName </em>- the area to create the entity at<br/>

<em>abFullGameSave </em>- determines whether an entity "remembers" its state
</p>
<pre class="code c"><span class="kw4">void</span> ReplaceEntity<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="sy0">,</span> string <span class="sy0">&</span>in asBodyName<span class="sy0">,</span> string <span class="sy0">&</span>in asNewEntityName<span class="sy0">,</span> string <span class="sy0">&</span>in asNewEntityFile<span class="sy0">,</span> bool abFullGameSave<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Removes an entity and places a new one in its place.
</p>

<p>
<em>asName</em> - Name of the entity to replace.<br/>

<em>asBodyName</em> - Name of the body of the entity to place the new entity at. If empty the first body is used (might be buggy, recommended to name a body anyway).<br/>

<em>asNewEntityName</em> - Name of the new entity.<br/>

<em>asNewEntityFile</em> - Name of the new entity file. Extension .ent.<br/>

<em>abFullGameSave</em> - Whether ALL properties of this entity should be saved throughout levels.
</p>
<pre class="code c++"><span class="kw4">void</span> PlaceEntityAtEntity<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="sy0">,</span> string <span class="sy0">&</span>in asTargetEntity<span class="sy0">,</span> string <span class="sy0">&</span>in asTargetBodyName<span class="sy0">,</span> bool abUseRotation<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Places an entity at the position of another entity. Does not work for enemies, use TeleportEnemyToEntity instead.
</p>

<p>
<em>asName</em> - Name of the entity to place.<br/>

<em>asTargetEntity</em> - Name of the other entity to place the first entity at.<br/>

<em>asTargetBodyName</em> - Name of the body of the entity to place the first entity at. If empty the first body is used (might be buggy, recommended to name a body anyway).<br/>

<em>abUseRotation</em> - Whether the entity should be rotated like the target entity.
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityPos<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="sy0">,</span> <span class="kw4">float</span> afZ<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Moves an entity to a position in the level.
</p>

<p>
<em>asName</em> - Name of the entity to move.<br/>

<em>afX</em> - X co-ordinate position.<br/>

<em>afY</em> - Y co-ordinate position.<br/>

<em>afZ</em> - Z co-ordinate position.
</p>
<pre class="code c"><span class="kw4">float</span> GetEntityPosX<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetEntityPosY<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>
<span class="kw4">float</span> GetEntityPosZ<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns an entity's position in the level on the specified axis.
</p>

<p>
<em>asName</em> - Name of the entity.
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityPlayerLookAtCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asCallback<span class="sy0">,</span> bool abRemoveWhenLookedAt<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Calls a function when the player looks at a certain entity.<br/>

Callback syntax: <b>void MyFunc(string &in asEntity, int alState)</b> <br/>

alState: 1 = looking, -1 = not looking
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asCallback </em>- function to call<br/>

<em>abRemoveWhenLookedAt </em>- determines whether the callback should be removed when the player looked at the entity
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityPlayerInteractCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asCallback<span class="sy0">,</span> bool abRemoveOnInteraction<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Calls a function when the player interacts with a certain entity.<br/>

Callback syntax: <b>void MyFunc(string &in asEntity)</b>
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asCallback </em>- function to call<br/>

<em>abRemoveOnInteraction </em>- determines whether the callback should be removed when the player interacts with the entity
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityCallbackFunc<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asCallback<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Calls a function when the player interacts with a certain entity.<br/>

Callback syntax: <b>void MyFunc(string &in asEntity, string &in type)</b> <br/>

Type depends on entity type and includes: "OnPickup", "Break", "OnIgnite", etc
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityConnectionStateChangeCallback<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asCallback<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
A callback called when ever the connection state changes (button being switched on, lever switched, etc).<br/>

Callback syntax: <b>void Func(string &in asEntity, int alState)</b> <br/>

alState: -1 = off, 0 = between, 1 = on
</p>
<pre class="code c"><span class="kw4">void</span> SetEntityInteractionDisabled<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> bool abDisabled<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Disallows interaction with an entity.
</p>
<pre class="code c"><span class="kw4">void</span> BreakJoint <span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Breaks a joint. Do not use this on joints in SwingDoors, Levers, Wheels, etc. where the joint is part of an interaction. That will make the game crash.
</p>
<pre class="code c"><span class="kw4">void</span> AddEntityCollideCallback<span class="br0">(</span>string<span class="sy0">&</span> asParentName<span class="sy0">,</span> string<span class="sy0">&</span> asChildName<span class="sy0">,</span> string<span class="sy0">&</span> asFunction<span class="sy0">,</span> bool abDeleteOnCollide<span class="sy0">,</span> <span class="kw4">int</span> alStates<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Calls a function when two entites collide.<br/>

Callback syntax: <b>void MyFunc(string &in asParent, string &in asChild, int alState)</b> <br/>

alState: 1 = enter, -1 = leave
</p>

<p>
<em>asParentName </em>- internal name of main object<br/>

<em>asChildName </em>- internal name of object that collides with main object (asterix (&lt;nowiki>&#42;&lt;/nowiki>) NOT supported!)<br/>

<em>asFunction </em>- function to call<br/>

<em>abDeleteOnCollide </em>- determines whether the callback after it was called<br/>

<em>alStates </em>- 1 = only enter, -1 = only leave, 0 = both
</p>
<pre class="code c"><span class="kw4">void</span> RemoveEntityCollideCallback<span class="br0">(</span>string<span class="sy0">&</span> asParentName<span class="sy0">,</span> string<span class="sy0">&</span> asChildName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Removes an EntityCollideCallback. Asterix (&lt;nowiki>&#42;&lt;/nowiki>) not supported in <em>asChildName</em>.
</p>
<pre class="code c">bool GetEntitiesCollide<span class="br0">(</span>string<span class="sy0">&</span> asEntityA<span class="sy0">,</span> string<span class="sy0">&</span> asEntityB<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether two entites collide. This function does NOT support asterix (&lt;nowiki>&#42;&lt;/nowiki>) or "Player"!
</p>
<pre class="code c"><span class="kw4">void</span> SetBodyMass<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afMass<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Sets the mass of an entity's body.
</p>

<p>
<em>asName</em> - Name of the body of an entity. The body name of an entity is EntityName_BodyName.<br/>

<em>afMass</em> - The mass to set.
</p>
<pre class="code c"><span class="kw4">float</span> GetBodyMass<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Gets the mass of an entity's body.
</p>

<p>
<em>asName</em> - Name of the body of an entity. The body name of an entity is EntityName_BodyName.<br/>

<em>afMass</em> - The mass to get.
</p>

</div>

<h4>Props</h4>
<div class="level4">
<pre class="code c"><span class="kw4">void</span> SetPropEffectActive<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> bool abFadeAndPlaySounds<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Can be used on coal to give it the black color it should have.
</p>
<pre class="code c"><span class="kw4">void</span> SetPropActiveAndFade<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Activates/deactivates a prop.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>abActive </em>- nothing to add<br/>

<em>afFadeTime </em>- time in seconds until prop fully fades
</p>
<pre class="code c"><span class="kw4">void</span> SetPropStaticPhysics<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Activates/deactivates the physics of a prop. Setting as true will make entities static in midair.
</p>
<pre class="code c">bool GetPropIsInteractedWith<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Checks whether a prop is interacted with.
</p>
<pre class="code c"><span class="kw4">void</span> RotatePropToSpeed<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> <span class="kw4">float</span> afAcc<span class="sy0">,</span> <span class="kw4">float</span> afGoalSpeed<span class="sy0">,</span> <span class="kw4">float</span> afAxisX<span class="sy0">,</span> <span class="kw4">float</span> afAxisY<span class="sy0">,</span> <span class="kw4">float</span> afAxisZ<span class="sy0">,</span> bool abResetSpeed<span class="sy0">,</span> string<span class="sy0">&</span> asOffsetArea<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
Rotates the prop up to a set speed.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>afAcc </em>- acceleration<br/>

<em>afGoalSpeed </em>- desired speed<br/>

<em>afAxisX </em>- rotation around X axis<br/>

<em>afAxisY </em>- rotation around Y axis<br/>

<em>afAxisZ </em>- rotation around Z axis<br/>

<em>abResetSpeed </em>- determines whether the speed is resetted after goal speed is reached<br/>

<em>asOffsetArea </em>- the area to rotate around, if empty, then the center of the body is used Note: The entity you want to rotate MUST be a "StaticObject" entity!
</p>
<pre class="code">void StopPropMovement(string& asName);



</pre><p> </p>




<p>
Stops all movement of a prop.
</p>
<pre class="code">void AddAttachedPropToProp(string& asPropName, string& asAttachName, string& asAttachFile, float afPosX, float afPosY, float afPosZ, float afRotX, float afRotY, float afRotZ);



</pre><p> </p>




<p>
Attaches a prop to another prop.
</p>

<p>
a<em>sPropName</em>- the prop to attach another prop at<br/>

<em>asAttachName </em>- internal name of the prop that gets attached<br/>

<em>asAttachFile </em>- the prop that gets attached extension .ent<br/>

<em>afPosX </em>- X position of the attach from the prop<br/>

<em>afPosY </em>- Y position of the attach from the prop<br/>

<em>afPosZ </em>- Z position of the attach from the prop<br/>

<em>afRotX </em>- rotation around X axis of the attach<br/>

<em>afRotY </em>- rotation around Y axis of the attach<br/>

<em>afRotZ </em>- rotation around ZX axis of the attach Note: for the purposes of "AddEntityCollideCallback", attached props will not call the callback function if they collide with a "static_object" or a "StaticProp" entity type!
</p>

<p>
<b>Bug:</b> <em>afRotZ </em> is used for both the ZX rotation and the Z position of the attached prop. Unwanted rotation can be avoided by using:<br/>

AddAttachedPropToProp(asPropName,asAttachName,asAttachFile,afPosX,afPosY,0,afPosZ,90.0f,afPosZ)
</p>

<p>
<b>Bug:</b> Attaching a breakable prop to a physically active prop, and then breaking the attached prop, will cause the game to crash should the parent object be moved or reset.
</p>
<pre class="code">void AttachPropToProp(string& asPropName, string& asAttachName, string& asAttachFile, float afPosX, float afPosY, float afPosZ, float afRotX, float afRotY, float afRotZ);



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Attaches a prop to another prop. Fixed version of AddAttachedPropToProp.
</p>

<p>
<em>asPropName </em>- the prop to attach another prop at<br/>

<em>asAttachName </em>- internal name of the prop that gets attached<br/>

<em>asAttachFile </em>- the prop that gets attached extension .ent<br/>

<em>afPosX </em>- X position of the attach from the prop<br/>

<em>afPosY </em>- Y position of the attach from the prop<br/>

<em>afPosZ </em>- Z position of the attach from the prop<br/>

<em>afRotX </em>- rotation around X axis of the attach<br/>

<em>afRotY </em>- rotation around Y axis of the attach<br/>

<em>afRotZ </em>- rotation around ZX axis of the attach Note: for the purposes of "AddEntityCollideCallback", attached props will not call the callback function if they collide with a "static_object" or a "StaticProp" entity type!
</p>
<pre class="code">void RemoveAttachedPropFromProp(string& asPropName, string& asAttachName);



</pre><p> </p>




<p>
Detaches a prop from a prop.
</p>
<pre class="code">void SetPropHealth(string& asName, float afHealth);
void AddPropHealth(string& asName, float afHealth);
float GetPropHealth(string& asName);



</pre><p> </p>




<p>
Modifies/returns the health of a prop.
</p>
<pre class="code">void ResetProp(string& asName);



</pre><p> </p>




<p>
Resets a prop's state to the original one when the map was loaded.
</p>
<pre class="code">void PlayPropAnimation(string& asProp, string& asAnimation, float afFadeTime, bool abLoop, string& asCallback);



</pre><p> </p>




<p>
Makes the prop play an animation and calls a function.<br/>

Callback syntax: <b>void MyFunc(string &in asProp)</b>
</p>

<p>
<em>asProp </em>- internal name of the prop<br/>

<em>asAnimation </em>- animation to play<br/>

<em>afFadeTime </em>- ?<br/>

<em>abLoop </em>- determines whether the animation loops<br/>

<em>asCallback </em>- function to call
</p>
<pre class="code">void AddPropForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddPropImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddBodyForce(string& asName, float afX, float afY, float afZ, string& asCoordSystem);
void AddBodyImpulse(string& asName, float afX, float afY, float afZ, string& asCoordSystem);



</pre><p> </p>




<p>
These functions push objects. Note that rather high values are needed when applying <em>forces</em> (on the order of ~100 (weak) to ~10000 (strong)), but not impulses (values less than 10 can be appropriate). Forces are external influences, and will have different effect depending on the mass of the object they are being applied to; impulses disregard mass, and can cause objects to break, as if hit. A "Body" is a physics-related helper object, to which a force or an impulse can be applied. Entities can consist of several bodies, interconnected in various ways (you can create/examine bodies in the model editor).
</p>

<p>
<em>asName </em>- the object to push; for bodies, use this format: "<em>entityName</em>_<em>bodyName</em>"<br/>

<em>afX </em>- magnitude along the X-axis<br/>

<em>afY </em>- magnitude along the Y-axis<br/>

<em>afZ </em>- magnitude along the Z-axis<br/>

<em>asCoordSystem </em>- determines which coordinate system is used, usually "world" All of these functions are <em>additive</em> - when called consecutively, for each call, the vectors defined by (afX, afY, afZ) will be added together, and a resultant force/impulse will be calculated <em>before</em> any physics simulation is applied to the target object.
</p>

</div>

<h4>Connections</h4>
<div class="level4">
<pre class="code">void InteractConnectPropWithRope(string& asName, string& asPropName, string& asRopeName, bool abInteractOnly, float afSpeedMul, float afToMinSpeed, float afToMaxSpeed, bool abInvert, int alStatesUsed);



</pre><p> </p>




<p>
Connects a prop with the movement of a rope (ie. turn wheel to move rope).
</p>

<p>
<em>asName </em>- connection name<br/>

<em>asPropName </em>- name of prop<br/>

<em>asRopeName </em>- name of rope<br/>

<em>abInteractOnly </em>- ?<br/>

<em>afSpeedMul </em>- speed multiplier of how quickly the rope moves<br/>

<em>afToMinSpeed </em>- the slowest the rope will move when moving the prop<br/>

<em>afToMaxSpeed </em>- the fastest the rope will move when moving the prop<br/>

<em>abInvert </em>- whether to invert the direction the rope moves<br/>

<em>alStatesUsed </em>- which states of the prop can interact with the rope?
</p>
<pre class="code">void InteractConnectPropWithMoveObject(string& asName, string& asPropName, string& asMoveObjectName, bool abInteractOnly, bool abInvert, int alStatesUsed);



</pre><p> </p>




<p>
This one should only be used if there must be an exact correspondance to prope "amount" and the moveobject open amount. It is best used for Wheel-door connections!
</p>
<pre class="code">void ConnectEntities(string& asName, string& asMainEntity, string& asConnectEntity, bool abInvertStateSent, int alStatesUsed, string& asCallbackFunc);



</pre><p> </p>




<p>
Callback syntax: <b>void MyFunc(string &in asConnectionName, string &in asMainEntity, string &in asConnectEntity, int alState)</b> <br/>

State is what is sent to connection entity and will be inverted if abInvertStateSent = true!
</p>

</div>

<h4>Lamps</h4>
<div class="level4">
<pre class="code">void SetLampLit(string& asName, bool abLit, bool abEffects);



</pre><p> </p>




<p>
(Un)lits a lamp.
</p>

<p>
<em>asName </em>- Name of the lamp<br/>

<em>abLit </em>- Set true if you want the lamp to be lit, set to false if you want the lamp to be unlit<br/>

<em>abEffects </em>- If you want to have the lamp fade in/out when it gets (un)lit
</p>

</div>

<h4>Doors</h4>
<div class="level4">
<pre class="code">void SetSwingDoorLocked(string& asName, bool abLocked, bool abEffects);
void SetSwingDoorClosed(string& asName, bool abClosed, bool abEffects);



</pre><p> </p>




<p>
Locks/closes a swing door.
</p>
<pre class="code">bool GetSwingDoorLocked(string& asName);
bool GetSwingDoorClosed(string& asName);



</pre><p> </p>




<p>
Checks whether a swing door is locked/closed.
</p>
<pre class="code">void SetSwingDoorDisableAutoClose(string& asName, bool abDisableAutoClose);



</pre><p> </p>




<p>
Deactivates the "auto-close" when a door is nearly closed.
</p>
<pre class="code">int GetSwingDoorState(string& asName);



</pre><p> </p>




<p>
Returns an integer depending on how far the door is opened.<br/>

-1 = angle is close to 0°, 1 = angle is 70% or higher of max, 0 = inbetween -1 and 1.
</p>
<pre class="code">void SetLevelDoorLocked(string& asName, bool abLocked);



</pre><p> </p>




<p>
Locks a level door. Note that level doors are NOT swing doors.
</p>
<pre class="code">void SetLevelDoorLockedSound(string& asName, string& asSound);



</pre><p> </p>




<p>
Determines which sound is played when interacting with a locked level door.
</p>
<pre class="code">void SetLevelDoorLockedText(string& asName, string& asTextCat, string& asTextEntry);



</pre><p> </p>




<p>
Displays a message when interacting with a locked level door.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>asTextCat </em>- the category in the .lang file<br/>

<em>asTextEntry </em>- the entry in the .lang file
</p>
<pre class="code">void SetMoveObjectState(string& asName, float afState);



</pre><p> </p>




<p>
Moves an object to a certain state.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>afState </em>- state of the object, 0 = closed, 1 = open, values inbetween (and above, for example, the bridge_metal_vert) are valid too!
</p>
<pre class="code">void SetMoveObjectStateExt(string& asName, float afState, float afAcc, float afMaxSpeed, float afSlowdownDist, bool abResetSpeed);



</pre><p> </p>




<p>
Moves an object to a certain state, extended method.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>afState </em>- state of the object, 0 = closed, 1 = open, values inbetween are valid too!<br/>

<em>afAcc </em>- acceleration<br/>

<em>afMaxSpeed </em>- maximum speed<br/>

<em>afSlowdownDist </em>- Distance to the target state before decceleration occurs.<br/>

<em>abResetSpeed </em>- Set to True if the prop's speed should be reset before performing the movement, else the prop will accelerate from it's current speed to afMaxSpeed.
</p>

</div>

<h4>Levers, wheels and buttons</h4>
<div class="level4">
<pre class="code">void SetPropObjectStuckState(string& asName, int alState);
void SetWheelStuckState(string& asName, int alState, bool abEffects);
void SetLeverStuckState(string& asName, int alState, bool abEffects);



</pre><p> </p>




<p>
Makes a prop&lt;nowiki>&#92;&lt;/nowiki>wheel&lt;nowiki>&#92;&lt;/nowiki>lever stuck in a certain state.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>alState </em>- 0 = not stuck, 1 = at max, -1 = at min<br/>

<em>abEffects </em>- use effects
</p>
<pre class="code">void SetWheelAngle(string& asName, float afAngle, bool abAutoMove);



</pre><p> </p>




<p>
Moves a wheel to a certain angle.
</p>

<p>
<em>asName </em>- internal name<br/>

<em>afAngle </em>- angle<br/>

<em>abAutoMove </em>- determines whether the wheel should move on its own
</p>
<pre class="code">void SetWheelInteractionDisablesStuck(string& asName, bool abX);
void SetLeverInteractionDisablesStuck(string& asName, bool abX);



</pre><p> </p>




<p>
Allows the player to make a wheel/lever unstuck when interacted with.
</p>
<pre class="code">int GetLeverState(string& asName);



</pre><p> </p>




<p>
Returns the state of the lever.<br/>

0 = not stuck, 1 = at max, -1 = at min
</p>
<pre class="code">void SetMultiSliderStuckState(string& asName, int alStuckState, bool abEffects);



</pre><p> </p>




<p>
Makes a MultiSlider stuck in a certain state.
</p>
<pre class="code">void SetMultiSliderCallback(string& asName, string& asCallback);



</pre><p> </p>




<p>
Calls a function when state changes.<br/>

Callback syntax: <b>void MyFunc(string &in asEntity, int alState)</b>
</p>
<pre class="code">void SetButtonSwitchedOn(string& asName, bool abSwitchedOn, bool abEffects);



</pre><p> </p>




</div>

<h4>Sticky areas</h4>
<div class="level4">
<pre class="code">void SetAllowStickyAreaAttachment(bool abX);



</pre><p> </p>




<p>
Allows entites to stick to a StickyArea.
</p>
<pre class="code">void AttachPropToStickyArea(string& asAreaName, string& asProp);
void AttachBodyToStickyArea(string& asAreaName, string& asBody);



</pre><p> </p>




<p>
Attaches a prop/body to a StickyArea.
</p>
<pre class="code">void DetachFromStickyArea(string& asAreaName);



</pre><p> </p>




<p>
Detaches everything from a StickyArea.
</p>

</div>

<h4>Enemies</h4>
<div class="level4">
<pre class="code">void SetNPCAwake(string& asName, bool abAwake, bool abEffects);



</pre><p> </p>




<p>
Activates the npc
</p>
<pre class="code">void SetNPCFollowPlayer(string& asName, bool abX);



</pre><p> </p>




<p>
Sets an NPC's head to follow the player's movement's.
</p>
<pre class="code">void SetEnemyDisabled(string& asName, bool abDisabled);



</pre><p> </p>




<p>
Disables an enemy.
</p>
<pre class="code">void SetEnemyIsHallucination(string& asName, bool abX);



</pre><p> </p>




<p>
Makes an enemy a hallucination. Hallucinations fade to smoke when they get near the player.
</p>
<pre class="code">void FadeEnemyToSmoke(string& asName, bool abPlaySound);



</pre><p> </p>




<p>
Instantly fades an enemy to smoke.
</p>
<pre class="code">void ShowEnemyPlayerPosition(string& asName);



</pre><p> </p>




<p>
Makes the enemy run to the player, no matter where he is.
</p>
<pre class="code">void AlertEnemyOfPlayerPresence(string &in asName);



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Gives the specified enemy the player's current position and makes it search the area.
</p>
<pre class="code">void SetEnemyDisableTriggers(string& asName, bool abX);



</pre><p> </p>




<p>
Enables or disables enemy triggers. If disabled, enemy will not react to player or attack.
</p>
<pre class="code">void AddEnemyPatrolNode(string& asName, string& asNodeName, float afWaitTime, string& asAnimation);



</pre><p> </p>




<p>
Adds a patrol node to the enemy's path.
</p>

<p>
<em>asName </em>- internal name of the enemy<br/>

<em>asNodeName </em>- path node<br/>

<em>afWaitTime </em>- time in seconds that the enemy waits at the path node before continuing<br/>

<em>asAnimation </em>- the animation the enemy uses when reaching the path node
</p>
<pre class="code">void ClearEnemyPatrolNodes(string& asEnemyName);



</pre><p> </p>




<p>
Clears the current path of patrol nodes of the enemy.
</p>
<pre class="code">void SetEnemySanityDecreaseActive(string &in asName, bool abX);



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables whether an enemy activates the player's sanity drain when stared at.
</p>

<p>
<em>asName </em>- Internal name of the enemy<br/>

<em>abX </em>- Enabled/disabled
</p>
<pre class="code">void TeleportEnemyToNode(string &in asEnemyName, string &in asNodeName, bool abChangeY);



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Teleports an enemy to a specific PathNode.
</p>

<p>
<em>asEnemyName </em>- Internal name of the enemy<br/>

<em>asNodeName </em>- Internal name of the node to teleport to<br/>

<em>abChangeY </em>- Whether the Y position of the node will be used when teleporting the enemy
</p>
<pre class="code">void TeleportEnemyToEntity(string &in asEnemyName, string &in asTargetEntity, string &in asTargetBody, bool abChangeY);



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Teleports an enemy to a specific entity.
</p>

<p>
<em>asEnemyName </em>- Internal name of the enemy<br/>

<em>asTargetEntity </em>- Internal name of the entity to teleport to<br/>

<em>asTargetBody</em>- Internal name of the entity's body name to teleport to. If empty, the first body will be used (might be unstable, recommended to input a body anyway)<br/>

<em>abChangeY </em>- Whether the Y position of the node will be used when teleporting the enemy
</p>
<pre class="code c"><span class="kw4">void</span> ChangeManPigPose<span class="br0">(</span>string<span class="sy0">&</span>in asName<span class="sy0">,</span> string<span class="sy0">&</span>in asPoseType<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Changes the pose a specified ManPig.
</p>

<p>
<em>asName </em>- Internal name of the enemy<br/>

<em>asPoseType</em>- Name of the ManPig pose to use. Can be "Biped" or "Quadruped"
</p>
<pre class="code c"><span class="kw4">void</span> SetTeslaPigFadeDisabled<span class="br0">(</span>string<span class="sy0">&</span>in asName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables whether a specified TeslaPig should fade the player's view in and out.
</p>

<p>
<em>asName </em>- Internal name of the enemy<br/>

<em>abX</em>- Enabled/disabled
</p>
<pre class="code c"><span class="kw4">void</span> SetTeslaPigSoundDisabled<span class="br0">(</span>string<span class="sy0">&</span>in asName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables whether a specified TeslaPig should play the proximity sounds.
</p>

<p>
<em>asName </em>- Internal name of the enemy<br/>

<em>abX</em>- Enabled/disabled
</p>
<pre class="code c"><span class="kw4">void</span> SetTeslaPigEasyEscapeDisabled<span class="br0">(</span>string<span class="sy0">&</span>in asName<span class="sy0">,</span> bool abX<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Enables/disables whether a specified TeslaPig should be easier to escape from when hunted.
</p>

<p>
<em>asName </em>- Internal name of the enemy<br/>

<em>abX</em>- Enabled/disabled
</p>
<pre class="code c"><span class="kw4">void</span> ForceTeslaPigSighting<span class="br0">(</span>string<span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Forces a TeslaPig to be visible for a short time.
</p>

<p>
<em>asName </em>- Internal name of the enemy
</p>
<pre class="code c">string<span class="sy0">&</span> GetEnemyStateName<span class="br0">(</span>string <span class="sy0">&</span>in asName<span class="br0">)</span><span class="sy0">;</span>



</pre><p> </p>




<p>
<img src="/lib/images/smileys/icon_exclaim.gif" class="icon" alt=":!:" /> <b>Requires 1.3</b>
</p>

<p>
Returns the name of the state a specified enemy is current in. States can be Hunt, Search, Patrol, Wait, Alert, Investigate, Track and BreakDoor.
</p>

<p>
<em>asName </em>- Internal name of the enemy
</p>

</div>
Frictional Game Wiki

User Tools

Site Tools

Page Tools
