Frictional Game Wiki

<h2>helper_modules.hps</h2> <div class="level2"> </div> <h5>Description_AddExt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Description_AddExt<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">,</span> bool abPutInQueueIfShowing<span class="sy0">,</span> bool abConnectedToPrevious<span class="sy0">,</span> eDescEffect aEffect<span class="sy0">,</span> <span class="kw4">float</span> afEffectAmount<span class="sy0">,</span> cColor aColor<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Description_Add</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Description_Add<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">,</span> bool abPutInQueueIfShowing<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Description_IsActive</h5> <div class="level5"> <pre class="code c++">bool Description_IsActive<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Description_GetCurrentId</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Description_GetCurrentId<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Description_SetForceFading</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Description_SetForceFading<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>TerrainParticles_Disable</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> TerrainParticles_Disable<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Disables terrain particles, they have to be setup again to be started </p> <hr /> </div> <h5>TerrainParticles_SetupRange</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> TerrainParticles_SetupRange<span class="br0">(</span><span class="kw4">float</span> afRangeMinStart<span class="sy0">,</span> <span class="kw4">float</span> afRangeMinEnd<span class="sy0">,</span> <span class="kw4">float</span> afRangeMaxStart<span class="sy0">,</span> <span class="kw4">float</span> afRangeMaxEnd<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets up the maximum and minimum distance that the particles are visible Particles also wrap around the maximum distance, coming out on the other side if they get to far away This should be called before spawning particles to get the best spread </p> <ul> <li class="level1"> <b>afRangeMinStart</b>: particles closer than this value will not be visible</li> <li class="level1"> <b>afRangeMinEnd</b>: particles between min start and min end will fade to fully visible</li> <li class="level1"> <b>afRangeMaxStart</b>: particles further away then this value will start to fade out</li> <li class="level1"> <b>afRangeMaxEnd</b>: particles further away then this will not be visible and will be spawned on the other side of the player</li> </ul> <hr /> </div> <h5>TerrainParticles_SetupParticles</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> TerrainParticles_SetupParticles<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMaterial<span class="sy0">,</span> <span class="kw4">int</span> alFixedAxisCount<span class="sy0">,</span> <span class="kw4">float</span> afFixedAxisSizeMin<span class="sy0">,</span> <span class="kw4">float</span> afFixedAxisSizeMax<span class="sy0">,</span> cColor avFixedColorMin<span class="sy0">,</span> cColor avFixedColorMax<span class="sy0">,</span> <span class="kw4">int</span> alPointSpriteCount<span class="sy0">,</span> <span class="kw4">float</span> afPointSpriteSizeMin<span class="sy0">,</span> <span class="kw4">float</span> afPointSpriteSizeMax<span class="sy0">,</span> cColor avPointColorMin<span class="sy0">,</span> cColor avPointColorMax<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Spawn particles that use the specified material There are two kind of particles. FixedAxis sprites follow the rotation of the surface. PointSprite always look at the player. </p> <ul> <li class="level1"> <b>asMaterial</b>: the mat file used by the particles</li> <li class="level1"> <b>alFixedAxisCount</b>: the number of FixedAxis particles to spawn</li> <li class="level1"> <b>afFixedAxisSizeMin</b>: smallest size of a FixedAxis particle</li> <li class="level1"> <b>afFixedAxisSizeMax</b>: largest size of a FixedAxis particle</li> <li class="level1"> <b>avFixedColorMin</b>: random color bound of the FixedAxis particle</li> <li class="level1"> <b>avFixedColorMax</b>: random color bound of the FixedAxis particle</li> <li class="level1"> <b>alPointSpriteCount</b>: the number of PointSprite particles to spawn</li> <li class="level1"> <b>afPointSpriteSizeMin</b>: smallest size of a PointSprite particle</li> <li class="level1"> <b>afPointSpriteSizeMax</b>: largest size of a PointSprite particle</li> <li class="level1"> <b>avPointColorMin</b>: random color bound of the PointSprite particle</li> <li class="level1"> <b>avPointColorMax</b>: random color bound of the PointSprite particle</li> </ul> <hr /> </div> <h5>TerrainParticles_SetupForces</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> TerrainParticles_SetupForces<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avVelocityLimit<span class="sy0">,</span> <span class="kw4">float</span> afGravityAmount<span class="sy0">,</span> <span class="kw4">float</span> afRandomDirectionForce<span class="sy0">,</span> <span class="kw4">float</span> afRandomDirectionFrequency<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup forces that affect the particles </p> <ul> <li class="level1"> <b>avVelocityLimit</b>: limit to velocity of the particles</li> <li class="level1"> <b>afGravityAmount</b>: how much gravity should affect the particles, value between 0.0-1.0</li> <li class="level1"> <b>afRandomDirectionForce</b>: the amount of random force that should be appled to the particles, the direction of this force is based on position and changes over time</li> <li class="level1"> <b>afRandomDirectionFrequency</b>: how fast the direction of the random force changes</li> </ul> <hr /> </div> <h5>TerrainParticles_SetupWind</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> TerrainParticles_SetupWind<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avWindForce<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Setup wind force that is applied to all particles </p> <ul> <li class="level1"> <b>avWindForce</b>: the force and direction of the wind, this is applied to all particles</li> </ul> <hr /> </div> <h5>DistortionEffect_AddInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> DistortionEffect_AddInstance<span class="br0">(</span>tID a_idEntity<span class="sy0">,</span> <span class="kw4">float</span> afMaxDistance<span class="sy0">,</span> <span class="kw4">float</span> afMinDistance<span class="sy0">,</span> <span class="kw4">float</span> afMaxAmount<span class="sy0">,</span> eEasing aEasing<span class="sy0">=</span>eEasing_Linear<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds the entity has an instance that will help create a distortion effect if the player is near enough. </p> <ul> <li class="level1"> <b>a_idEntity</b>: The entity who this will be connected to.</li> <li class="level1"> <b>afMaxDistance</b>: The distance at which the effect will start.</li> <li class="level1"> <b>afMinDistance</b>: The distance when the effect will be at max</li> <li class="level1"> <b>afMaxAmount</b>: The max amount the effect will have from this entity.</li> <li class="level1"> <b>aEasing</b>: The easing function used to fade between max and min</li> </ul> <hr /> </div> <h5>DistortionEffect_RemoveInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> DistortionEffect_RemoveInstance<span class="br0">(</span>tID a_idEntity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Removes an instance that will create the distortion effect. </p> <ul> <li class="level1"> <b>a_idEntity</b>: The entity to break the connection with</li> </ul> <hr /> </div> <h5>LightFlash_Add</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> LightFlash_Add<span class="br0">(</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="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTargetEntity<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> afRadius<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates a flash of light at the postion of an entity. Returns id of the flash. </p> <ul> <li class="level1"> <b>afTime</b>: The time that light light stays at full intensity</li> <li class="level1"> <b>afFadeInTime</b>: How long it takes to fade in</li> <li class="level1"> <b>afFadeOutTime</b>: How long it takes to fade out</li> <li class="level1"> <b>asTargetEntity</b>: Entity at which it will be created.</li> <li class="level1"> <b>aColor</b>: The color of the light.</li> <li class="level1"> <b>afRadius</b>: The radius of the light (this will NOT be faded, it starts with this radius, and then just color fades in)</li> <li class="level1"> <b>afBrightness</b>: The brightness of the light.</li> </ul> <hr /> </div> <h5>LightFlash_Add</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> LightFlash_Add<span class="br0">(</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="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avTargetPos<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> afRadius<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates a flash of light at the postion of an entity. Returns id of the flash. </p> <ul> <li class="level1"> <b>afTime</b>: The time that light light stays at full intensity</li> <li class="level1"> <b>afFadeInTime</b>: How long it takes to fade in</li> <li class="level1"> <b>afFadeOutTime</b>: How long it takes to fade out</li> <li class="level1"> <b>avTargetPos</b>: Position at which it will be created.</li> <li class="level1"> <b>aColor</b>: The color of the light.</li> <li class="level1"> <b>afRadius</b>: The radius of the light (this will NOT be faded, it starts with this radius, and then just color fades in)</li> <li class="level1"> <b>afBrightness</b>: The brightness of the light.</li> </ul> <hr /> </div> <h5>ToolHandler_CanPickOrUseTool</h5> <div class="level5"> <pre class="code c++">bool ToolHandler_CanPickOrUseTool<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if it is OK to use an item or picking one up. Basically just wanna make sure the tool handler (or something else) is not playing an animation (apart form idle) </p> <hr /> </div> <h5>ToolHandler_CanEquipToolAreaTool</h5> <div class="level5"> <pre class="code c++">bool ToolHandler_CanEquipToolAreaTool<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Meant for tool area. Does a check to see if it is OK to equip the tool in that area. </p> <hr /> </div> <h5>ToolHandler_GetPlayerCarriesHeavyTool</h5> <div class="level5"> <pre class="code c++">bool ToolHandler_GetPlayerCarriesHeavyTool<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the player carries a tool that is heavy </p> <hr /> </div> <h5>ToolHandler_IsActive</h5> <div class="level5"> <pre class="code c++">bool ToolHandler_IsActive<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Is active? </p> <hr /> </div> <h5>ToolHandler_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> ToolHandler_SetActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>AttackMeter_AddInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_AddInstance<span class="br0">(</span>tID a_idEntity<span class="sy0">,</span> <span class="kw4">float</span> afStartDistance<span class="sy0">,</span> <span class="kw4">float</span> afEndDistance<span class="sy0">,</span> <span class="kw4">float</span> afDamage<span class="sy0">,</span> bool abFatal<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abFastNonLookKill<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abInstantKnockOut<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds an entity as something that is about to damage the player. </p> <ul> <li class="level1"> <b>a_idEntity</b>: ID for the entity</li> <li class="level1"> <b>afStartDistance</b>: How close entity needs to be before the attack meter starts.</li> <li class="level1"> <b>afEndDistance</b>: How close the entity needs to be for the player to take damange</li> <li class="level1"> <b>afDamage</b>: How much damage will the attack take?</li> <li class="level1"> <b>abFatal</b>: If true then this death is instantly fatal rather than allowing you to die 3 times.</li> <li class="level1"> <b>abFastNonLookKill</b>: If true, the entity will damage quickly even if the player isn't looking at it.</li> <li class="level1"> <b>abInstantKnockOut</b>: if true, the player will be knocked out on the first attack</li> </ul> <hr /> </div> <h5>AttackMeter_RemoveInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_RemoveInstance<span class="br0">(</span>tID a_idEntity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Removes an entity as something that is about to damage the player. </p> <ul> <li class="level1"> <b>a_idEntity</b>: ID for the entity</li> </ul> <hr /> </div> <h5>AttackMeter_AutoDamage</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_AutoDamage<span class="br0">(</span><span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afDamage<span class="sy0">,</span> bool abFatal<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This starts a timer that will damage the player when it is over. </p> <ul> <li class="level1"> <b>afTime</b>: ID for the entity</li> <li class="level1"> <b>afDamage</b>: Amount of damage dealt to the player</li> <li class="level1"> <b>abFatal</b>: If true, the damage can kill the player</li> </ul> <hr /> </div> <h5>AttackMeter_IsActive</h5> <div class="level5"> <pre class="code c++">bool AttackMeter_IsActive<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if any effects are active </p> <hr /> </div> <h5>AttackMeter_SetPlayerIsRecovering</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_SetPlayerIsRecovering<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Manually set that the player is in recovery mode as if he has just been attacked. While true, most Agents refrain from attacking and player cannot get knocked down. </p> <hr /> </div> <h5>AttackMeter_GetPlayerIsRecovering</h5> <div class="level5"> <pre class="code c++">bool AttackMeter_GetPlayerIsRecovering<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Check if the attack meter has just damaged the player and the player currently have the effects caused by that. </p> <hr /> </div> <h5>AttackMeter_SetCustomDamageCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_SetCustomDamageCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallback<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This lets you do your own damage event. Nothing is done in the AttackHandler when damage is to occurs except calling this. </p> <ul> <li class="level1"> <b>asCallback</b>: The callback function to be used. Syntax: void f(const tString &in asSource)</li> </ul> <hr /> </div> <h5>AttackMeter_SetAfterDamageCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_SetAfterDamageCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCallback<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This sets a callback that is called after taken daming. </p> <ul> <li class="level1"> <b>asCallback</b>: The callback function to be used. Syntax: void f(const tString& in asSource)</li> </ul> <hr /> </div> <h5>AttackMeter_SetAttackerTeleportPosition</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_SetAttackerTeleportPosition<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asPosition<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the player blacks out when damaged the agent that hurt him will be telported to one of these postions. </p> <hr /> </div> <h5>AttackMeter_GetAttackerTeleportPosition</h5> <div class="level5"> <pre class="code c++">tString AttackMeter_GetAttackerTeleportPosition<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the base name (with wildcards) that was set with AttackMeter_SetAttackerTeleportPosition </p> <hr /> </div> <h5>AttackMeter_BreakAttackDamageSequence</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_BreakAttackDamageSequence<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Only to be called in _Global_PlayerAfterDamageCallback of an Agent or in an AfterDamageCallback. It breaks the sequence to continue. The following things will be changed WorldAll volume to 0, player move & look speed, effect fade out, and PlayerIsRecovering is true. </p> <hr /> </div> <h5>AttackMeter_ContinueAttackDamageSequence</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> AttackMeter_ContinueAttackDamageSequence<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Only to be called after _Global_PlayerAfterDamageCallback of an Agent or in an AfterDamageCallback if AttackMeter_BreakAttackDamageSequence has been called. This simple continue this </p> <hr /> </div> <h5>AttackMeter_GetTimeSinceLastKnockDown</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> AttackMeter_GetTimeSinceLastKnockDown<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Time since player was last knocked down. </p> <hr /> </div> <h5>GameOver_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> GameOver_Start<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asDeathSource<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts the Game Over screen </p> <hr /> </div> <h5>GameOver_End</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> GameOver_End<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Ends the Game Over screen </p> <hr /> </div> <h5>GameOver_GetTimeSinceLastGameOver</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> GameOver_GetTimeSinceLastGameOver<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Ends the Game Over screen </p> <hr /> </div> <h5>GameOver_SetCustomGameOverScreenText</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> GameOver_SetCustomGameOverScreenText<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEntry<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the message that will be displayed before a checkpoint is loaded (after proper death): </p> <hr /> </div> <h5>Emotion_StartHeartbeat</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Emotion_StartHeartbeat<span class="br0">(</span><span class="kw4">float</span> afTimeBetweenBeats<span class="sy0">,</span> <span class="kw4">float</span> afVolume<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="sy0">,</span> <span class="kw4">float</span> afDuration<span class="sy0">=-</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">=</span><span class="nu0">3</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="sy0">=</span><span class="nu0">3</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts a new instance of heart beats </p> <ul> <li class="level1"> <b>afTimeBetweenBeats</b>: The time between the beats</li> <li class="level1"> <b>afVolume</b>: Volume of the heart beats (0-1)</li> <li class="level1"> <b>alPrio</b>: The prio of instnace. Higher is played over low.er</li> <li class="level1"> <b>afDuration</b>: How long the heart beats lasts, -1 means until stopped.</li> <li class="level1"> <b>afFadeInTime</b>: The time it takes for this instance to fade in.</li> <li class="level1"> <b>afFadeOutTime</b>: The time it takes to fade out, only used if no instance is active.</li> </ul> <hr /> </div> <h5>Emotion_StopHeartbeat</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Emotion_StopHeartbeat<span class="br0">(</span><span class="kw4">int</span> alId<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops an instance of heart beats. </p> <ul> <li class="level1"> <b>alId</b>: The ID of the instance</li> </ul> <hr /> </div> <h5>Emotion_SetHeartbeatProperties</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Emotion_SetHeartbeatProperties<span class="br0">(</span><span class="kw4">int</span> alId<span class="sy0">,</span> <span class="kw4">float</span> afTimeBetweenBeats<span class="sy0">,</span> <span class="kw4">float</span> afVolume<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the properties for heart beat instance </p> <ul> <li class="level1"> <b>alId</b>: The ID of the instance</li> <li class="level1"> <b>afTimeBetweenBeats</b>: Time between beats</li> <li class="level1"> <b>afVolume</b>: Volume for the beat</li> </ul> <hr /> </div> <h5>Emotion_StartBackgroundBreath</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Emotion_StartBackgroundBreath<span class="br0">(</span>eBreathType aType<span class="sy0">,</span> <span class="kw4">float</span> afStrength<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="sy0">,</span> <span class="kw4">float</span> afDuration<span class="sy0">=-</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeInSpeed<span class="sy0">=</span><span class="nu17">0.2f</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeOutSpeed<span class="sy0">=</span><span class="nu17">0.2f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts a new instance of background breathing. Returns ID of the instnace. </p> <ul> <li class="level1"> <b>aType</b>: The type of breath.</li> <li class="level1"> <b>afStrength</b>: The strength of the breaths. Must be 0 - 1.</li> <li class="level1"> <b>alPrio</b>: The prio of this instance. Higher is played over lower.</li> <li class="level1"> <b>afDuration</b>: How long the breathing lasts, -1 means until stopped.</li> <li class="level1"> <b>afFadeInSpeed</b>: the speed (note NOT time) that used when fading to this instance. If &lt;0, the FadeOut from a previous instance is used.</li> <li class="level1"> <b>afFadeOutSpeed</b>: if going back to default breathing or the upcoming has&lt;0 as FadeInSpeed, this it the speed (NOT time) used. Note that if another instance is taking over, its FadeInSpeed will be used instead.</li> </ul> <hr /> </div> <h5>Emotion_StopBackgroundBreath</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Emotion_StopBackgroundBreath<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops an instance of background breathing. </p> <ul> <li class="level1"> <b>alID</b>: The ID of the instance</li> </ul> <hr /> </div> <h5>Emotion_SetBackgroundBreathMuted</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Emotion_SetBackgroundBreathMuted<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets an instance of background breathing muted. Note that this muting only works if the is the top prio instnace and in that case no other instance will play either. </p> <ul> <li class="level1"> <b>alID</b>: The ID of the instance</li> <li class="level1"> <b>abX</b>: If the instance is muted. -1 = the default breathing.</li> </ul> <hr /> </div> <h5>Emotion_PlayEventBreath</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Emotion_PlayEventBreath<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asSound<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="sy0">=</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Plays an event breathing sound. </p> <ul> <li class="level1"> <b>asSound</b>: The name of the sound file/event to play.</li> <li class="level1"> <b>alPrio</b>: The prio of the sound, if a a breaht is already playing having higher prio overrides. 0 is lowest prio and usually used for non-critical stuff (such as breathing when crawling), so mostly use 1 or higher.</li> </ul> <hr /> </div> <h5>Wake_SetAsleep</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Wake_SetAsleep<span class="br0">(</span>bool abAsleep<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Puts the player instantly to sleep (or awake) </p> <ul> <li class="level1"> <b>abAsleep</b>: if true then the player is asleep, if false then awake</li> </ul> <hr /> </div> <h5>Wake_StartWakeup</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Wake_StartWakeup<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Wakes up the player. </p> <ul> <li class="level1"> <b>afTime</b>: time to take to wake up.</li> </ul> <hr /> </div> <h5>PauseMenu_Enabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PauseMenu_Enabled<span class="br0">(</span>bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if the pause menu is allowed to be used </p> <hr /> </div> <h5>PauseMenu_Show</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PauseMenu_Show<span class="br0">(</span>bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Show the pause manu </p> <hr /> </div> <h5>MainMenu_Show</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> MainMenu_Show<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If main menu should be shown </p> <hr /> </div> <h5>MainMenu_IsShowing</h5> <div class="level5"> <pre class="code c++">bool MainMenu_IsShowing<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Return whether the Main Menu is active or not </p> <hr /> </div> <h5>MainMenu_GameOver</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> MainMenu_GameOver<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returning to the main menu when the game's complete </p> <hr /> </div> <h5>MainMenu_SetBGPhase</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> MainMenu_SetBGPhase<span class="br0">(</span>eMainMenuPhase aPhase<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Change main menu BG state </p> <hr /> </div> <h5>MainMenu_SetIsE3Demo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> MainMenu_SetIsE3Demo<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>LastOnSoma_SetText</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LastOnSoma_SetText<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asText<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowHint</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_ShowHint<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowHint_Hold</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Hint_ShowHint_Hold<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowInfo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_ShowInfo<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowInfo_Hold</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Hint_ShowInfo_Hold<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowDanger</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_ShowDanger<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowDanger_Hold</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Hint_ShowDanger_Hold<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowAlert</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_ShowAlert<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_ShowAlert_Hold</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Hint_ShowAlert_Hold<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afTimeMul<span class="sy0">=</span><span class="nu17">1.5f</span><span class="sy0">,</span> bool abAddAsGiven<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_Show_Helper</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_Show_Helper<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asHeaderEntry<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<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> afTimeMul<span class="sy0">,</span> bool abAddAsGiven<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_Show_Ext</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Hint_Show_Ext<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asHeaderCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asHeaderEntry<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTextEntry<span class="sy0">,</span> bool abIsInputHint<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> afTimeMul<span class="sy0">,</span> bool abAddAsGiven<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_Release</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_Release<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_StopHint</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_StopHint<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_AddAsGiven</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_AddAsGiven<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Hint_AddAsGiven</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Hint_AddAsGiven<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCat<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEntry<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Infection_CreateBorderTree</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Infection_CreateBorderTree<span class="br0">(</span><span class="kw4">int</span> alBorder<span class="sy0">,</span> <span class="kw4">float</span> afOffset<span class="sy0">,</span> <span class="kw4">const</span> cVector2f <span class="sy0">&</span>in avSize<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates an infection tree at a border of the screen </p> <hr /> </div> <h5>Infection_ClearTrees</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Infection_ClearTrees<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Clears all created trees. </p> <hr /> </div> <h5>PlayerEnergy_GetMoveMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> PlayerEnergy_GetMoveMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerEnergy_GetLookMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> PlayerEnergy_GetLookMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerEnergy_SetFlowerSwallows</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerEnergy_SetFlowerSwallows<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerEnergy_SetAllowCathComment</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerEnergy_SetAllowCathComment<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Inventory_AutoEnable</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Inventory_AutoEnable<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This really means 'show the inventory!' but too late to rename now. <img src="/lib/images/smileys/icon_biggrin.gif" class="icon" alt=":-D" /> </p> <hr /> </div> <h5>Inventory_SetEnabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Inventory_SetEnabled<span class="br0">(</span>bool abEnabled<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Disables/enables the 'show inventory' key. </p> <hr /> </div> <h5>PlayerHands_SetHandModel</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetHandModel<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFile<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetHandModel_Human</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetHandModel_Human<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetHandModel_Diving</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetHandModel_Diving<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetHandModel_DeepSea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetHandModel_DeepSea<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetHandModel_DeepSeaMutilated</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetHandModel_DeepSeaMutilated<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PreloadHandModel</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PreloadHandModel<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFile<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PreloadHandModel_Human</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PreloadHandModel_Human<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PreloadHandModel_Diving</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PreloadHandModel_Diving<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PreloadHandModel_DeepSea</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PreloadHandModel_DeepSea<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PreloadHandModel_DeepSeaMutilated</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PreloadHandModel_DeepSeaMutilated<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_PlayAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_PlayAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAnim<span class="sy0">,</span> bool abLoop<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abFullScaleModel<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.0f</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAttachedProp<span class="sy0">=</span>""<span class="sy0">,</span> bool abDisableWhenOver<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="sy0">=</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afRelTimePos<span class="sy0">=-</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_GetAnimationPlaying</h5> <div class="level5"> <pre class="code c++">bool PlayerHands_GetAnimationPlaying<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_IsActive</h5> <div class="level5"> <pre class="code c++">bool PlayerHands_IsActive<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetUseCustomRotation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetUseCustomRotation<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetCustomRotation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetCustomRotation<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avRot<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetCustomRotationFromEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetCustomRotationFromEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetUseCustomPosition</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetUseCustomPosition<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetCustomPosition</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetCustomPosition<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPos<span class="sy0">,</span> bool abUseBasicOffset<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetCustomPositionFromEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetCustomPositionFromEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_GetBoneState</h5> <div class="level5"> <pre class="code c++">cBoneState PlayerHands_GetBoneState<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asBone<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_GetSocket</h5> <div class="level5"> <pre class="code c++">cNode3D PlayerHands_GetSocket<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asSocket<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_GetCurrentAnimationState</h5> <div class="level5"> <pre class="code c++">cAnimationState PlayerHands_GetCurrentAnimationState<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_AttachCameraToSocket</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_AttachCameraToSocket<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asBoneName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asFadeOverCallback<span class="sy0">,</span> bool abDisablePlayer<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abAutoDetach<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afDetachTime<span class="sy0">=</span><span class="nu17">1.0f</span><span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPosOffset<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avRotOffset<span class="sy0">=</span><span class="nu0">0</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_DetachCameraFromSocket</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_DetachCameraFromSocket<span class="br0">(</span><span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetAnimationOverCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetAnimationOverCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFunction<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_SetVisible</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> PlayerHands_SetVisible<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>PlayerHands_GetEntityName</h5> <div class="level5"> <pre class="code c++">tString PlayerHands_GetEntityName<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>LoadScreen_SetBackground</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LoadScreen_SetBackground<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 background texture used by the loading screen </p> <hr /> </div> <h5>LoadScreen_SetForceBackground</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LoadScreen_SetForceBackground<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if you want to force showing the background. </p> <hr /> </div> <h5>LoadScreen_SetIcon</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LoadScreen_SetIcon<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFirstFrame<span class="sy0">,</span> <span class="kw4">int</span> alFrameNum<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the icon used by the loading screen when loading or saving </p> <hr /> </div> <h5>LoadScreen_SetUseSmallIcon</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LoadScreen_SetUseSmallIcon<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If fullscreen icon should be used or if it should be shown in the bottom right corner </p> <hr /> </div> <h5>LoadScreen_IsVisible</h5> <div class="level5"> <pre class="code c++">bool LoadScreen_IsVisible<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>LoadScreen_ShowLoadingIcon</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> LoadScreen_ShowLoadingIcon<span class="br0">(</span><span class="kw4">float</span> afTimeMax<span class="sy0">=</span><span class="nu17">10.0f</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Credits_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Credits_Start<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCreditsFile<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCompleteCallback<span class="sy0">=</span>""<span class="sy0">,</span> <span class="kw4">float</span> afRollSpeedStart<span class="sy0">=</span><span class="nu17">0.00f</span><span class="sy0">,</span> <span class="kw4">float</span> afRollSpeedGoal<span class="sy0">=</span><span class="nu17">0.008f</span><span class="sy0">,</span> <span class="kw4">float</span> afRollSpeedFadeTime<span class="sy0">=</span><span class="nu17">1.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts the credits screen </p> <hr /> </div> <h5>Credits_SetRollSpeed</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Credits_SetRollSpeed<span class="br0">(</span><span class="kw4">float</span> afGoal<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes rolling speed </p> <hr /> </div> <h5>Credits_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Credits_Stop<span class="br0">(</span><span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Dismisses the credits screen </p> <hr /> </div>