Frictional Game Wiki

<h2>helper_map.hps</h2> <div class="level2"> </div> <h5>Map_GetTimeStamp</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Map_GetTimeStamp<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This gets the number of ticks (60/second is default) since start of map. </p> <hr /> </div> <h5>Map_GetElapsedTime</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Map_GetElapsedTime<span class="br0">(</span><span class="kw4">int</span> alTimeStamp<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets how long time it has elapsed since the time step was retrieved. </p> <ul> <li class="level1"> <b>alTimeStamp</b>: value gotten from Map_GetTimeStamp</li> </ul> <hr /> </div> <h5>Map_SetDisplayNameEntry</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetDisplayNameEntry<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNameEntry<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the displayed name of the current map. </p> <ul> <li class="level1"> <b>asNameEntry</b>: new name of the map.</li> </ul> <hr /> </div> <h5>Map_SetSkyBoxActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetSkyBoxActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Activates or deactivates the skybox of the current map </p> <ul> <li class="level1"> <b>abX</b>: true = activate - false = deactivate.</li> </ul> <hr /> </div> <h5>Map_SetSkyBoxTexture</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetSkyBoxTexture<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTexture<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the texture of the skybox in the current map </p> <ul> <li class="level1"> <b>asTexture</b>: file name of the texture to set.</li> </ul> <hr /> </div> <h5>Map_SetSkyBoxColor</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetSkyBoxColor<span class="br0">(</span><span class="kw4">const</span> cColor <span class="sy0">&</span>in acColor<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the color of the skybox in the current map </p> <ul> <li class="level1"> <b>acColor</b>: color to set.</li> </ul> <hr /> </div> <h5>Map_SetFogActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetFogActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Activates or deactivates fog in the current map </p> <ul> <li class="level1"> <b>abX</b>: true = activate - false = deactivate.</li> </ul> <hr /> </div> <h5>Map_SetFogProperties</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_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> <span class="kw4">const</span> cColor <span class="sy0">&</span>in acColor<span class="sy0">,</span> bool abCulling<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the properties of the fog in the current map </p> <ul> <li class="level1"> <b>afStart</b>: start distance of fog.</li> <li class="level1"> <b>afEnd</b>: distance where the fog effect is maxed out.</li> <li class="level1"> <b>afFalloffExp</b>: rate at which the fog effect will decrease over the distance between afStart and afEnd.</li> <li class="level1"> <b>acColor</b>: color of fog.</li> <li class="level1"> <b>abCulling</b>: true = objects hidden by fog are not rendered - false = fog has no effect on whether objects are rendered or not.</li> </ul> <hr /> </div> <h5>Map_SetSecondaryFogActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetSecondaryFogActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Activates or deactivates the secondary fog </p> <ul> <li class="level1"> <b>abX</b>: true = activate - false = deactivate.</li> </ul> <hr /> </div> <h5>Map_SetSecondaryFogProperties</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetSecondaryFogProperties<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> <span class="kw4">const</span> cColor <span class="sy0">&</span>in acColor<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the properties of the secondary fog, both the primary and secondary fog will be applied, these are order independent </p> <ul> <li class="level1"> <b>afStart</b>: start distance of fog.</li> <li class="level1"> <b>afEnd</b>: distance where the fog effect is maxed out.</li> <li class="level1"> <b>afFalloffExp</b>: rate at which the fog effect will decrease over the distance between afStart and afEnd.</li> <li class="level1"> <b>acColor</b>: color of fog.</li> </ul> <hr /> </div> <h5>Map_FadeFogStart</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeFogStart<span class="br0">(</span><span class="kw4">float</span> afTarget<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_FadeFogEnd</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeFogEnd<span class="br0">(</span><span class="kw4">float</span> afTarget<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_FadeFogColor</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeFogColor<span class="br0">(</span><span class="kw4">const</span> cColor <span class="sy0">&</span>in aTarget<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_FadeFogFalloffExp</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeFogFalloffExp<span class="br0">(</span><span class="kw4">float</span> afTarget<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_SetEnvironmentParticlesActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticlesActive<span class="br0">(</span>bool abState<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_GetEnvironmentParticles</h5> <div class="level5"> <pre class="code c++">array <span class="sy0"><</span> cEnvironmentParticles @<span class="sy0">></span> Map_GetEnvironmentParticles<span class="br0">(</span>tString asName<span class="sy0">,</span> array<span class="sy0"><</span> cEnvironmentParticles @<span class="sy0">></span> <span class="sy0">&</span>inout avParticles<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get all env particles that match name </p> <hr /> </div> <h5>Map_SetEnvironmentParticleVisible</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleVisible<span class="br0">(</span>tString asName<span class="sy0">,</span> bool abVisible<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Toggle visiblity for specific layer </p> <hr /> </div> <h5>Map_SetEnvironmentParticleGravityVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleGravityVelocity<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the gravity of the env particles </p> <hr /> </div> <h5>Map_SetEnvironmentParticleRotateVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleRotateVelocity<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the rotation of the env particles </p> <hr /> </div> <h5>Map_SetEnvironmentParticleWindVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleWindVelocity<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the wind of the env particles </p> <hr /> </div> <h5>Map_FadeEnvironmentParticleWindVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeEnvironmentParticleWindVelocity<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the wind velocity of all env particles over time </p> <hr /> </div> <h5>Map_FadeEnvironmentParticleColor</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeEnvironmentParticleColor<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cColor <span class="sy0">&</span>in aColor<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the color of the env particle </p> <hr /> </div> <h5>Map_FadeEnvironmentParticleBrightness</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeEnvironmentParticleBrightness<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the brightness of the env particle </p> <hr /> </div> <h5>Map_SetEnvironmentParticleColor</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleColor<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cColor <span class="sy0">&</span>in aColor<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the color of the env particle </p> <hr /> </div> <h5>Map_SetEnvironmentParticleFadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleFadeOut<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afStart<span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set the fade out settings for the environment particles. </p> <hr /> </div> <h5>Map_SetEnvironmentParticleFadeIn</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleFadeIn<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afStart<span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set the fade in settings for the environment particles. </p> <hr /> </div> <h5>Map_AddEnvironmentParticleClipArea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_AddEnvironmentParticleClipArea<span class="br0">(</span>tString asName<span class="sy0">,</span> tString asClipSourceEntity<span class="sy0">,</span> bool abAdditive<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the wind of the env particles </p> <hr /> </div> <h5>Map_RemoveEnvironmentParticleClipArea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_RemoveEnvironmentParticleClipArea<span class="br0">(</span>tString asName<span class="sy0">,</span> tString asClipSourceEntity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the wind of the env particles </p> <hr /> </div> <h5>Map_SetEnvironmentParticlesSpotLight</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticlesSpotLight<span class="br0">(</span>tString asName<span class="sy0">,</span> cLightSpot @apLight<span class="sy0">,</span> <span class="kw4">float</span> afMul<span class="sy0">=</span><span class="nu17">1.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set flashlight to affect particles </p> <hr /> </div> <h5>Map_SetPlayerTerrainCollision</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetPlayerTerrainCollision<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If player should collide with the terrain or not. </p> <hr /> </div> <h5>Map_SetEnvironmentParticleGravityVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleGravityVelocity<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_SetEnvironmentParticleRotateVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleRotateVelocity<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_SetEnvironmentParticleWindVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetEnvironmentParticleWindVelocity<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_FadeEnvironmentParticleWindVelocity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeEnvironmentParticleWindVelocity<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocity<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_Preset_SetupFog</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupFog<span class="br0">(</span>tString asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afStart<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afFalloffExp<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> cColor aColor<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> bool abUnderwater<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abSkybox<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup fog for the specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>abActive</b>: If fog should be active</li> <li class="level1"> <b>afStart</b>: Where fog starts showing</li> <li class="level1"> <b>afEnd</b>: Where fog has full effect</li> <li class="level1"> <b>afFalloffExp</b>: How fast the fog fades to full effect, lower is faster</li> <li class="level1"> <b>aColor</b>: Color of the fog</li> <li class="level1"> <b>afBrightness</b>: Brightness of the fog</li> <li class="level1"> <b>abUnderwater</b>: If underwater fog should be used</li> <li class="level1"> <b>abSkybox</b>: If fog color should be taken from skybox</li> </ul> <hr /> </div> <h5>Map_Preset_SetupSecondaryFog</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupSecondaryFog<span class="br0">(</span>tString asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afStart<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afFalloffExp<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> cColor aColor<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="sy0">=</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup secondary fog for the specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>abActive</b>: If fog should be active</li> <li class="level1"> <b>afStart</b>: Where fog starts showing</li> <li class="level1"> <b>afEnd</b>: Where fog has full effect</li> <li class="level1"> <b>afFalloffExp</b>: How fast the fog fades to full effect, lower is faster</li> <li class="level1"> <b>aColor</b>: Color of the fog</li> <li class="level1"> <b>afBrightness</b>: Brightness of the fog</li> </ul> <hr /> </div> <h5>Map_Preset_SetupDepthOfField</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupDepthOfField<span class="br0">(</span>tString asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afStart<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afEnd<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afFalloff<span class="sy0">=</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup depth of field for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>abActive</b>: If DoF should be active</li> <li class="level1"> <b>afStart</b>: Where near plane starts</li> <li class="level1"> <b>afEnd</b>: Where far plane starts</li> <li class="level1"> <b>afFalloff</b>: How fast the depth of field fades in</li> </ul> <hr /> </div> <h5>Map_Preset_SetupBloom</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupBloom<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afWidth<span class="sy0">,</span> <span class="kw4">float</span> afBrightPass<span class="sy0">,</span> <span class="kw4">float</span> afFalloff<span class="sy0">,</span> cColor aTint<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup bloom for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>afWidth</b>: If bloom should be active</li> <li class="level1"> <b>afBrightPass</b>: How bright</li> <li class="level1"> <b>afFalloff</b>: Falloff of the bloom blur</li> <li class="level1"> <b>aTint</b>: Color and brightness of bloom</li> </ul> <hr /> </div> <h5>Map_Preset_SetupDirLight</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupDirLight<span class="br0">(</span>tString asName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> cColor aDiffuseColor<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="sy0">,</span> cVector3f avDirection<span class="sy0">,</span> cColor aGroundColor<span class="sy0">,</span> cColor aSkyColor<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup Direcitonal light for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>abActive</b>: If dir light should be active</li> <li class="level1"> <b>aDiffuseColor</b>: Base color of the light</li> <li class="level1"> <b>afBrightness</b>: How bright</li> <li class="level1"> <b>avDirection</b>: Direction of the light</li> <li class="level1"> <b>aGroundColor</b>: Ground color of the ambient light</li> <li class="level1"> <b>aSkyColor</b>: Sky color of the ambient light</li> </ul> <hr /> </div> <h5>Map_Preset_SetupToneMapping</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupToneMapping<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afToneMappingKey<span class="sy0">,</span> <span class="kw4">float</span> afToneMappingExposure<span class="sy0">,</span> <span class="kw4">float</span> afToneMappingWhiteCut<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup tonemapping for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>afToneMappingKey</b>: Multiplier of the light</li> <li class="level1"> <b>afToneMappingExposure</b>: Brightness of the tonemapping, value is in log2</li> <li class="level1"> <b>afToneMappingWhiteCut</b>: Colors brighter than this value will be clamped to white</li> </ul> <hr /> </div> <h5>Map_Preset_SetupColorGrading</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupColorGrading<span class="br0">(</span>tString asName<span class="sy0">,</span> tString asColorGrading<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup color grading for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>asColorGrading</b>: Texture to use</li> </ul> <hr /> </div> <h5>Map_Preset_SetupSkybox</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_SetupSkybox<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">const</span> cColor <span class="sy0">&</span>in aColor<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup skybox for specified preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>aColor</b>: Skybox color</li> <li class="level1"> <b>afBrightness</b>: Brightness for the skybox color</li> </ul> <hr /> </div> <h5>Map_Preset_Fade</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preset_Fade<span class="br0">(</span>tString asName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade in the preset </p> <ul> <li class="level1"> <b>asName</b>: Name of the preset</li> <li class="level1"> <b>afFadeTime</b>: How long it should take to fade in</li> </ul> <hr /> </div> <h5>Map_CopyGlobalSettings</h5> <div class="level5"> <pre class="code c++">bool Map_CopyGlobalSettings<span class="br0">(</span>cLuxMap @apMap<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Copies and fades in settings of another map </p> <ul> <li class="level1"> <b>apMap</b>: Map to copy from</li> <li class="level1"> <b>afFadeTime</b>: How long it should take to fade in</li> </ul> <hr /> </div> <h5>Map_SetDistanceCullingRange</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetDistanceCullingRange<span class="br0">(</span><span class="kw4">float</span> afRange<span class="sy0">,</span> <span class="kw4">float</span> afRandomSize<span class="sy0">=</span><span class="nu0">0</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Actives distance culling and sets the min and max range to the value. Any objects further away then that range will get culled Only use this function on maps that dont have distance culling active from the .map file </p> <ul> <li class="level1"> <b>afRange</b>: any object further away than this will get culled</li> <li class="level1"> <b>afRandomSize</b>: adds a little random distance to each object, so that not all objects are culled at exactly the same distance</li> </ul> <hr /> </div> <h5>Map_DisableDistanceCulling</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_DisableDistanceCulling<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Disables distance culling </p> <hr /> </div> <h5>Map_SetUnderwater</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetUnderwater<span class="br0">(</span>bool abX<span class="sy0">,</span> bool abUseStartAndEndEffects<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if the map is underwater or not, and the correct properties for the state. </p> <ul> <li class="level1"> <b>abX</b>: if the map should be underwater or not.</li> <li class="level1"> <b>abUseStartAndEndEffects</b>: if special effect should play at start or end.</li> </ul> <hr /> </div> <h5>Map_GetUnderwater</h5> <div class="level5"> <pre class="code c++">bool Map_GetUnderwater<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets if the map is under water or not. </p> <p> <b>Returns</b>: true if the map is underwater. </p> <hr /> </div> <h5>Map_AddTimer</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_AddTimer<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asFunction<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Syntax for callback function, void FunctionName(const tString &in asTimer). syntax for the callback function code snippet, clbTimer. </p> <hr /> </div> <h5>Map_RemoveTimer</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_RemoveTimer<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Remove a created timer. </p> <ul> <li class="level1"> <b>asName</b>: name of the timer to remove. (if called inside a timer callback, the parent timer will be chosen in case there are many with the same name)</li> </ul> <hr /> </div> <h5>Map_GetTimerTime</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Map_GetTimerTime<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the current time of a created timer. </p> <ul> <li class="level1"> <b>asName</b>: name of the timer. (if called inside a timer callback, the parent timer will be chosen in case there are many with the same name)</li> </ul> <hr /> </div> <h5>Map_TimerExists</h5> <div class="level5"> <pre class="code c++">bool Map_TimerExists<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get if the specified timer exists. </p> <ul> <li class="level1"> <b>asName</b>: name of the timer. (if called inside a timer callback, the parent timer will be chosen in case there are many with the same name)</li> </ul> <p> <b>Returns</b>: bool, true if the timer exists. </p> <hr /> </div> <h5>Map_SetTimerPaused</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetTimerPaused<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Pause/unpause a created timer. </p> <ul> <li class="level1"> <b>asName</b>: name of the timer to remove. (if called inside a timer callback, the parent timer will be chosen in case there are many with the same name)</li> <li class="level1"> <b>abX</b>: true = pause - false = unpause.</li> </ul> <hr /> </div> <h5>Map_TimeHasPassed</h5> <div class="level5"> <pre class="code c++">bool Map_TimeHasPassed<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if a timer with the specified name has reached 0, and if so recreates the timer with the specified time and returns true. Use in if-cases to limit how often the script within the case can run. </p> <ul> <li class="level1"> <b>asName</b>: name of the timer to check/create. (if called inside a timer callback, the parent timer will be chosen in case there are many with the same name)</li> <li class="level1"> <b>afTime</b>: time to set the timer to if created.</li> </ul> <p> <b>Returns</b>: bool, true if the time has passed and a new timer was created, otherwise false. </p> <hr /> </div> <h5>Map_RestartCurrentTimer</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_RestartCurrentTimer<span class="br0">(</span><span class="kw4">float</span> afNewTime<span class="sy0">=-</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If used inside a timer callback it will restart that the timer that issued that callback. </p> <ul> <li class="level1"> <b>afNewTime</b>: The time for the new timer to make a callback, if &lt;0 then previous time is used.</li> </ul> <hr /> </div> <h5>Map_SetTimerUserVarFloat</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetTimerUserVarFloat<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_SetTimerUserVarInt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetTimerUserVarInt<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">int</span> alX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_SetTimerUserVarString</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetTimerUserVarString<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_GetTimerUserVarFloat</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Map_GetTimerUserVarFloat<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_GetTimerUserVarInt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Map_GetTimerUserVarInt<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_GetTimerUserVarString</h5> <div class="level5"> <pre class="code c++">tString Map_GetTimerUserVarString<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_IncTimerUserVarFloat</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Map_IncTimerUserVarFloat<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">int</span> afX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_IncTimerUserVarInt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Map_IncTimerUserVarInt<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">int</span> alX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Map_GetEntity</h5> <div class="level5"> <pre class="code c++">iLuxEntity Map_GetEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> eLuxEntityType aType<span class="sy0">=</span>eLuxEntityType_LastEnum<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asClass<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the entity with the given name. </p> <ul> <li class="level1"> <b>asName</b>: the name of the entity.</li> <li class="level1"> <b>aType</b>: (optional), the type of entity (as an enum).</li> <li class="level1"> <b>asClass</b>: (optional), the class of the entity.</li> </ul> <p> <b>Returns</b>: iLuxEntity @, the requested entity, or null if the entity was not found. </p> <hr /> </div> <h5>Map_GetEntityArray</h5> <div class="level5"> <pre class="code c++">bool Map_GetEntityArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array<span class="sy0"><</span> iLuxEntity @<span class="sy0">></span> <span class="sy0">&</span>inout avOutEntities<span class="sy0">,</span> eLuxEntityType aEntityType<span class="sy0">=</span>eLuxEntityType_LastEnum<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns an array of entities with a given name. </p> <ul> <li class="level1"> <b>asName</b>: name of entities. May contain * as wildcards.</li> <li class="level1"> <b>avOutEntities</b>: reference to array that will be filled with lights.</li> <li class="level1"> <b>aEntityType</b>: type of entity to filter by - eLuxEntityType_LastEnum for all types</li> </ul> <p> <b>Returns</b>: true if any entities found </p> <hr /> </div> <h5>Map_GetProp</h5> <div class="level5"> <pre class="code c++">cLuxProp Map_GetProp<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asClass<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the prop with the given name. </p> <ul> <li class="level1"> <b>asName</b>: the name of the prop.</li> <li class="level1"> <b>asClass</b>: (optional), the class of the prop.</li> </ul> <p> <b>Returns</b>: cLuxProp @, the requested prop, or null if the prop was not found. </p> <hr /> </div> <h5>Map_GetLight</h5> <div class="level5"> <pre class="code c++">iLight Map_GetLight<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns a light with the given name. </p> <ul> <li class="level1"> <b>asName</b>: name of light</li> </ul> <p> <b>Returns</b>: iLight @, the requested light </p> <hr /> </div> <h5>Map_GetSoundEntityArray</h5> <div class="level5"> <pre class="code c++">array <span class="sy0"><</span> cSoundEntity @<span class="sy0">></span> Map_GetSoundEntityArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array<span class="sy0"><</span> cSoundEntity @<span class="sy0">></span> <span class="sy0">&</span>inout avOutSoundEntities<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates an array of sound entities with a given name. </p> <ul> <li class="level1"> <b>asName</b>: name of the sound entities. May contain * as wildcards.</li> <li class="level1"> <b>avOutSoundEntities</b>: reference to array that will be filled with sounds.</li> </ul> <p> <b>Returns</b>: array< cSoundEntity >, array of sound entities found. </p> <hr /> </div> <h5>Map_GetEntityID</h5> <div class="level5"> <pre class="code c++">tID Map_GetEntityID<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> eLuxEntityType aType<span class="sy0">=</span>eLuxEntityType_LastEnum<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asClass<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the entity with the given name. </p> <ul> <li class="level1"> <b>asName</b>: the name of the entity.</li> <li class="level1"> <b>aType</b>: (optional), the type of entity (as an enum).</li> <li class="level1"> <b>asClass</b>: (optional), the class of the entity.</li> </ul> <p> <b>Returns</b>: tID , the id to the prop, tID_Invalid returned if not found </p> <hr /> </div> <h5>Map_GetPropID</h5> <div class="level5"> <pre class="code c++">tID Map_GetPropID<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asClass<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the prop with the given name. </p> <ul> <li class="level1"> <b>asName</b>: the name of the prop.</li> <li class="level1"> <b>asClass</b>: (optional), the class of the prop.</li> </ul> <p> <b>Returns</b>: tID , the id to the prop, tID_Invalid returned if not found </p> <hr /> </div> <h5>Map_GetLensFlareIDArray</h5> <div class="level5"> <pre class="code c++">array <span class="sy0"><</span> tID <span class="sy0">></span> Map_GetLensFlareIDArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array<span class="sy0"><</span> tID <span class="sy0">></span> <span class="sy0">&</span>inout avOutLensFlares<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates an array of lens flares with a given name. </p> <ul> <li class="level1"> <b>asName</b>: name of lens flares. May contain * as wildcards.</li> <li class="level1"> <b>avOutLensFlares</b>: reference to array that will be filled with lens flares.</li> </ul> <p> <b>Returns</b>: array&lt;tID>, array of id to lens flares found. </p> <hr /> </div> <h5>Map_GetSoundEntityIDArray</h5> <div class="level5"> <pre class="code c++">array <span class="sy0"><</span> tID <span class="sy0">></span> Map_GetSoundEntityIDArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array<span class="sy0"><</span> tID <span class="sy0">></span> <span class="sy0">&</span>inout avOutSoundEntities<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates an array of sound entities with a given name. </p> <ul> <li class="level1"> <b>asName</b>: name of the sound entities. May contain * as wildcards.</li> <li class="level1"> <b>avOutSoundEntities</b>: reference to array that will be filled with lights.</li> </ul> <p> <b>Returns</b>: array&lt;tID>, array of id to sound entities found. </p> <hr /> </div> <h5>Map_GetParticleSystemIDArray</h5> <div class="level5"> <pre class="code c++">array <span class="sy0"><</span> tID <span class="sy0">></span> Map_GetParticleSystemIDArray<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> array<span class="sy0"><</span> tID <span class="sy0">></span> <span class="sy0">&</span>inout avOutParticles<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates an array of particle systems with a given name. </p> <ul> <li class="level1"> <b>asName</b>: name of particle systems. May contain * as wildcards.</li> <li class="level1"> <b>avOutParticles</b>: reference to array that will be filled with particle systems.</li> </ul> <p> <b>Returns</b>: array&lt;tID>, array of id to particle systems found. </p> <hr /> </div> <h5>Map_ChangeMap</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_ChangeMap<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMapName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asStartPos<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asStartSound<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEndSound<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the active map to the one specified. </p> <ul> <li class="level1"> <b>asMapName</b>: map to change to.</li> <li class="level1"> <b>asStartPos</b>: name of the player start node that the player should begin at.</li> <li class="level1"> <b>asStartSound</b>: sound that plays before loading the map.</li> <li class="level1"> <b>asEndSound</b>: sound that plays as the new map starts.</li> </ul> <hr /> </div> <h5>Map_ChangeMap</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_ChangeMap<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMapName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asStartPos<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTransferArea<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asStartSound<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEndSound<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the active map to the one specified. </p> <ul> <li class="level1"> <b>asMapName</b>: map to change to.</li> <li class="level1"> <b>asStartPos</b>: name of the player start node that the player should begin at.</li> <li class="level1"> <b>asTransferArea</b>: name of the area used to transfer objects (and the player) from one map to another</li> <li class="level1"> <b>asStartSound</b>: sound that plays before loading the map.</li> <li class="level1"> <b>asEndSound</b>: sound that plays as the new map starts.</li> </ul> <hr /> </div> <h5>Map_Preload</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Preload<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMapName<span class="sy0">,</span> eWorldStreamPriority aPrio<span class="sy0">=</span>eWorldStreamPriority_Normal<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts loading in assets for the next map </p> <ul> <li class="level1"> <b>asMapName</b>: Map to load data for</li> <li class="level1"> <b>aPrio</b>: How intrusive the preload is</li> </ul> <hr /> </div> <h5>Map_SetPreloadPriority</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetPreloadPriority<span class="br0">(</span>eWorldStreamPriority aPrio<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Prioirty of background download thread </p> <ul> <li class="level1"> <b>aPrio</b>: How intrusive the preload is</li> </ul> <hr /> </div> <h5>Map_GetPreloadMap</h5> <div class="level5"> <pre class="code c++">cLuxMap Map_GetPreloadMap<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the map that is currently being preloaded </p> <hr /> </div> <h5>Map_Deload</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_Deload<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTransferArea<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Deloads the objects in the current map </p> <ul> <li class="level1"> <b>asTransferArea</b>: Objects inside this area will not be deloaded</li> </ul> <hr /> </div> <h5>Map_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_FadeOut<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out the screen and all the sounds. Should be called some second before calling change map </p> <ul> <li class="level1"> <b>afTime</b>: time to fade out over</li> </ul> <hr /> </div> <h5>Map_IsChanging</h5> <div class="level5"> <pre class="code c++">bool Map_IsChanging<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns if a map change is occuring </p> <hr /> </div> <h5>Map_IsPreloading</h5> <div class="level5"> <pre class="code c++">bool Map_IsPreloading<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns if a map is being streamed in </p> <hr /> </div> <h5>Map_IsPreloadCompleted</h5> <div class="level5"> <pre class="code c++">bool Map_IsPreloadCompleted<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns if the map has been fully preloaded </p> <hr /> </div> <h5>Map_SetInteractionWhiteListActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_SetInteractionWhiteListActive<span class="br0">(</span>bool abActive<span class="sy0">,</span> bool abClearList<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Disables interaction on all entities that are not on the white list </p> <ul> <li class="level1"> <b>abActive</b>: if the white list should be used</li> <li class="level1"> <b>abClearList</b>: if the white list should be reset</li> </ul> <hr /> </div> <h5>Map_AddEntityToInteractionWhiteList</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_AddEntityToInteractionWhiteList<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds an entity to the white list, meaning that is can be intereacted with </p> <ul> <li class="level1"> <b>asName</b>: Name of the entity</li> </ul> <hr /> </div> <h5>Map_CheckLineOfSight</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_CheckLineOfSight<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avStart<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avEnd<span class="sy0">,</span> bool abCheckOnlyShadowCasters<span class="sy0">,</span> bool abCheckOnlyStatic<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the line of sight between two positions is clear </p> <ul> <li class="level1"> <b>asCallbackFunc</b>: callback function to call the result, syntax: void func(bool abClear)</li> <li class="level1"> <b>avStart</b>: origin of the check</li> <li class="level1"> <b>avEnd</b>: end of the check</li> <li class="level1"> <b>abCheckOnlyShadowCasters</b>: if only shadow casters should be checked</li> <li class="level1"> <b>abCheckOnlyStatic</b>: if only static bodies should be checked</li> </ul> <hr /> </div> <h5>Map_GetClosestEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_GetClosestEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avStart<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avDir<span class="sy0">,</span> <span class="kw4">float</span> afRayLength<span class="sy0">,</span> <span class="kw4">int</span> alInteractType<span class="sy0">,</span> bool abCheckLineOfSight<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the closest entity in direction </p> <ul> <li class="level1"> <b>asCallbackFunc</b>: callback function to call the result, syntax: void func(bool abSuccesful, float afDistance,</li> <li class="level1"> <b>avStart</b>: origin of the check</li> <li class="level1"> <b>avDir</b>: direction to check in</li> <li class="level1"> <b>afRayLength</b>: max distance to cast ray</li> <li class="level1"> <b>alInteractType</b>: interaction type</li> <li class="level1"> <b>abCheckLineOfSight</b>: if the entity has to be in view</li> </ul> <hr /> </div> <h5>Map_GetClosestBody</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_GetClosestBody<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avStart<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avDir<span class="sy0">,</span> <span class="kw4">float</span> afRayLength<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the closest body in direction </p> <ul> <li class="level1"> <b>asCallbackFunc</b>: callback function to call the result, syntax: void func(bool abSuccesful, float afDistance, const</li> <li class="level1"> <b>avStart</b>: origin of the check</li> <li class="level1"> <b>avDir</b>: direction to check in</li> <li class="level1"> <b>afRayLength</b>: max distance to cast ray</li> </ul> <hr /> </div> <h5>Map_GetClosestCharCollider</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_GetClosestCharCollider<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avStart<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avDir<span class="sy0">,</span> <span class="kw4">float</span> afRayLength<span class="sy0">,</span> bool abCheckDynamic<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the closest physics body that can collide with a character </p> <ul> <li class="level1"> <b>asCallbackFunc</b>: callback function to call the result, syntax: void func(bool abSuccesful, float afDistance, const</li> <li class="level1"> <b>avStart</b>: origin of the check</li> <li class="level1"> <b>avDir</b>: direction to check in</li> <li class="level1"> <b>afRayLength</b>: max distance to cast ray</li> <li class="level1"> <b>abCheckDynamic</b>: if both dynamic and static physics should be checked against</li> </ul> <hr /> </div> <h5>Map_GetLightLevelAtPos</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Map_GetLightLevelAtPos<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPos<span class="sy0">,</span> iLight @apSkipLight<span class="sy0">=</span><span class="kw2">null</span><span class="sy0">,</span> <span class="kw4">float</span> afRadiusAdd<span class="sy0">=</span><span class="nu16">0.25</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get how bright the position of the map is </p> <ul> <li class="level1"> <b>asCallbackFunc</b>: callback function to call the result, syntax: void func(float afLightLevel)</li> <li class="level1"> <b>avPos</b>: position to check</li> <li class="level1"> <b>apSkipLight</b>: light not to use in the check</li> <li class="level1"> <b>afRadiusAdd</b>: additional radius to search to simulate a area instead of a point</li> </ul> <hr /> </div> <h5>Visibility_SetAreaActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Visibility_SetAreaActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asName<span class="sy0">,</span> bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if visibility area is active (visible) or not. </p> <ul> <li class="level1"> <b>asName</b>: Name of the entity, Wildcard(s) * are supporeed</li> <li class="level1"> <b>abActive</b>: If true, area will become active</li> </ul> <hr /> </div> <h5>Visibility_SetMainActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Visibility_SetMainActive<span class="br0">(</span>bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if the main visiblity area should be active </p> <hr /> </div> <h5>Visibility_SetTerrainActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Visibility_SetTerrainActive<span class="br0">(</span>bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if the terrain should be visible area should be active </p> <hr /> </div> <h5>Decal_SetVisibleInArea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Decal_SetVisibleInArea<span class="br0">(</span>bool abVisible<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avMin<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avMax<span class="sy0">,</span> array<span class="sy0"><</span> tString <span class="sy0">></span> avMaterials<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets visiblity of all decals with material in the area </p> <ul> <li class="level1"> <b>abVisible</b>: If visible or not</li> <li class="level1"> <b>avMin</b>: Min of area</li> <li class="level1"> <b>avMax</b>: Max of area</li> <li class="level1"> <b>avMaterials</b>: Array of decals with materials to affect</li> </ul> <hr /> </div> <h5>Decal_SetVisibleInArea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Decal_SetVisibleInArea<span class="br0">(</span>bool abVisible<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asArea<span class="sy0">,</span> array<span class="sy0"><</span> tString <span class="sy0">></span> avMaterials<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets visiblity of all decals with material in the area </p> <ul> <li class="level1"> <b>abVisible</b>: If visible or not</li> <li class="level1"> <b>asArea</b>: Name of the area that the decals has to intersect with</li> <li class="level1"> <b>avMaterials</b>: Array of decals with materials to affect</li> </ul> <hr /> </div> <h5>Decal_SetVisibleInArea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Decal_SetVisibleInArea<span class="br0">(</span>bool abVisible<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asArea<span class="sy0">,</span> tString asMaterial<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets visiblity of all decals with material in the area </p> <ul> <li class="level1"> <b>abVisible</b>: If visible or not</li> <li class="level1"> <b>asArea</b>: Name of the area that the decals has to intersect with</li> <li class="level1"> <b>asMaterial</b>: Only decals with this material will be affected</li> </ul> <hr /> </div>