Frictional Game Wiki

<h2>helper_player.hps</h2> <div class="level2"> </div> <h5>Player_GetPosition</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetPosition<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the position of the player. </p> <p> <b>Returns</b>: cVector3f , The position of the player. </p> <hr /> </div> <h5>Player_GetFeetPosition</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetFeetPosition<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the feet position of the player. </p> <p> <b>Returns</b>: cVector3f , The position of the player's feet. </p> <hr /> </div> <h5>Player_GetDistanceToEntitySquared</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetDistanceToEntitySquared<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntity<span class="br0">)</span> </pre><p> </p> <ul> <li class="level1"> <b>asEntity</b>: The entity name</li> </ul> <p> <b>Returns</b>: float, The square of the distance the entity is from the player. </p> <hr /> </div> <h5>Player_GetDistanceToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetDistanceToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntity<span class="br0">)</span> </pre><p> </p> <ul> <li class="level1"> <b>asEntity</b>: The entity name</li> </ul> <p> <b>Returns</b>: float, The distance the entity is from the player. </p> <hr /> </div> <h5>Player_SetUnderwater</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetUnderwater<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether player is underwater or not, setting up various properties for this </p> <ul> <li class="level1"> <b>abX</b>: if underwater or not.</li> </ul> <hr /> </div> <h5>Player_GetUnderwater</h5> <div class="level5"> <pre class="code c++">bool Player_GetUnderwater<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Retuns if the player is under water or not. </p> <hr /> </div> <h5>Player_SetCharacterBodyDefaults</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCharacterBodyDefaults<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Reset the properties of the character body to what they were when the game started </p> <hr /> </div> <h5>Player_SetGravity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetGravity<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avGravity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set the level of gravity affecting the player </p> <ul> <li class="level1"> <b>avGravity</b>: the gravity vector to use.</li> </ul> <hr /> </div> <h5>Player_SetGravityEnabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetGravityEnabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Enable or disable gravity affecting the player </p> <ul> <li class="level1"> <b>abX</b>: if gravity is enabled or not.</li> </ul> <hr /> </div> <h5>Player_SetFallDamageActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFallDamageActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether fall damage is allowed or not. </p> <ul> <li class="level1"> <b>abX</b>: true = can take fall damage. - false = cannot take fall damage.</li> </ul> <hr /> </div> <h5>Player_Jump</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_Jump<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Makes the player jump </p> <hr /> </div> <h5>Player_SetCrouching</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCrouching<span class="br0">(</span>bool abState<span class="sy0">,</span> bool abInstant<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abSilent<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether player is crouching or not. </p> <ul> <li class="level1"> <b>abState</b>: true = player crouches - false = player stops crouching.</li> <li class="level1"> <b>abInstant</b>: true = camera moves to new position instantly - false = camera moves to new position over time.</li> <li class="level1"> <b>abSilent</b>: false = play sounds, true = don't play sounds</li> </ul> <hr /> </div> <h5>Player_GetCrouching</h5> <div class="level5"> <pre class="code c++">bool Player_GetCrouching<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets whether player is crouching or not. </p> <p> <b>Returns</b>: bool, true = player crouches - false = player is not crouching. </p> <hr /> </div> <h5>Player_IncCrawlCount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_IncCrawlCount<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Increaments the crawl counter, which if it is >0and player is crouching it means the player is crawling. </p> <hr /> </div> <h5>Player_DecCrawlCount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_DecCrawlCount<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Decrements the crawl counter, which if it is >0 and player is crouching it means the player is crawling. </p> <hr /> </div> <h5>Player_SetForceCrawling</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetForceCrawling<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Forces the player to be in crawling mode no matter if they are standing or not. </p> <hr /> </div> <h5>Player_SetDisableCrawling</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetDisableCrawling<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns off crawling and forces it not to occur again. </p> <hr /> </div> <h5>Player_GetHeadBob</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetHeadBob<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the current headbob amount </p> <hr /> </div> <h5>Player_GetRunning</h5> <div class="level5"> <pre class="code c++">bool Player_GetRunning<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets whether player is running or not. </p> <hr /> </div> <h5>Player_SetFootWear</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFootWear<span class="br0">(</span>tString <span class="sy0">&</span>in asType<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set what type of footwear the player has. </p> <ul> <li class="level1"> <b>asType</b>: can be: barefoot, sneaker, default. For Depth default will be the soma steps.</li> </ul> <hr /> </div> <h5>Player_SetClothing</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetClothing<span class="br0">(</span>tString <span class="sy0">&</span>in asType<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set what type of clothing the player is wearing. These change the jump and pose sounds. </p> <ul> <li class="level1"> <b>asType</b>: can be: naked, dressed, default. For Depth default will be the soma body.</li> </ul> <hr /> </div> <h5>Player_SetHeadBobMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetHeadBobMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the head bob amount multiplier </p> <ul> <li class="level1"> <b>afMul</b>: the amount of headbob, 0=none, 1=normal</li> </ul> <hr /> </div> <h5>Player_FadeHeadBobMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeHeadBobMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">=</span><span class="nu17">1.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the head bob amount multiplier </p> <ul> <li class="level1"> <b>afMul</b>: the amount of headbob, 0=none, 1=normal</li> <li class="level1"> <b>afTime</b>: the time to fade over</li> </ul> <hr /> </div> <h5>Player_GetHeadBobMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetHeadBobMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the head bob amount multiplier </p> <hr /> </div> <h5>Player_SetFootstepSoundsDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFootstepSoundsDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if foot steps sounds (landing included) should be played or not. </p> <ul> <li class="level1"> <b>abX</b>: true = steps should be played - false = steps should not be playe</li> </ul> <hr /> </div> <h5>Player_SetRunBreathingDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetRunBreathingDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Player_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if the player can control the main character. </p> <ul> <li class="level1"> <b>abX</b>: set controls active or not.</li> </ul> <hr /> </div> <h5>Player_GetLookSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetLookSpeedMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the player's look speed multiplier </p> <p> <b>Returns</b>: float, the speed multiplier, where 1.0 is the default value </p> <hr /> </div> <h5>Player_SetLookSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetLookSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the player's look speed multiplier </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to set, where 1.0 is the default value</li> </ul> <hr /> </div> <h5>Player_FadeLookSpeedMulTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeLookSpeedMulTo<span class="br0">(</span><span class="kw4">float</span> afMul<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the player's look speed multiplier over a specified time. </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to fade to, where 1.0 is the default value</li> <li class="level1"> <b>afTime</b>: time to fade over.</li> </ul> <hr /> </div> <h5>Player_GetMoveSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetMoveSpeedMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the player's move speed multiplier </p> <p> <b>Returns</b>: float, the speed multiplier, where 1.0 is the default value </p> <hr /> </div> <h5>Player_SetMoveSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetMoveSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the player's move speed multiplier </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to set, where 1.0 is the default value</li> </ul> <hr /> </div> <h5>Player_FadeMoveSpeedMulTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeMoveSpeedMulTo<span class="br0">(</span><span class="kw4">float</span> afMul<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the player's move speed multiplier over a specified time. </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to fade to, where 1.0 is the default value</li> <li class="level1"> <b>afTime</b>: time to fade over.</li> </ul> <hr /> </div> <h5>Player_GetRunSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetRunSpeedMul<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the player's script run speed multiplier </p> <p> <b>Returns</b>: float, the speed multiplier, where 1.0 is the default value </p> <hr /> </div> <h5>Player_SetRunSpeedMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetRunSpeedMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the player's script run speed multiplier </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to set, where 1.0 is the default value</li> </ul> <hr /> </div> <h5>Player_FadeRunSpeedMulTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeRunSpeedMulTo<span class="br0">(</span><span class="kw4">float</span> afMul<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the player's run speed multiplier over a specified time. </p> <ul> <li class="level1"> <b>afMul</b>: multiplier value to fade to, where 1.0 is the default value</li> <li class="level1"> <b>afTime</b>: time to fade over.</li> </ul> <hr /> </div> <h5>Player_SetJumpDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetJumpDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether jumping should be disabled or not. </p> <ul> <li class="level1"> <b>abX</b>: true = jumping is disabled - false = jumping is enabled</li> </ul> <hr /> </div> <h5>Player_CancelJump</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_CancelJump<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If a jump is currently in progress, cancel it. </p> <hr /> </div> <h5>Player_SetCrouchActionDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCrouchActionDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether anything should happen when you press the crouch button </p> <ul> <li class="level1"> <b>abX</b>: </li> </ul> <hr /> </div> <h5>Player_SetCrouchDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCrouchDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether crouching should be disabled or not. </p> <ul> <li class="level1"> <b>abX</b>: true = crouching is disabled - false = crouching is enabled</li> </ul> <hr /> </div> <h5>Player_SetStandDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetStandDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether standing should be disabled or not. </p> <ul> <li class="level1"> <b>abX</b>: true = standing is disabled - false = standing is enabled</li> </ul> <hr /> </div> <h5>Player_SetAfterDamageCrawl</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetAfterDamageCrawl<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the crawling taking place is a special after taking damage </p> <ul> <li class="level1"> <b>abX</b>: If active or not.</li> </ul> <hr /> </div> <h5>Player_SetSlowStandupMotion</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetSlowStandupMotion<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the player should move much slower when rising up from crouch. </p> <ul> <li class="level1"> <b>abX</b>: If active or not.</li> </ul> <hr /> </div> <h5>Player_WasDamaged</h5> <div class="level5"> <pre class="code c++">bool Player_WasDamaged<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns true if the player was damaged this update, else false. </p> <hr /> </div> <h5>Player_GetCurrentStateName</h5> <div class="level5"> <pre class="code c++">tString Player_GetCurrentStateName<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the name of the current state. </p> <hr /> </div> <h5>Player_ChangeStateToNormal</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_ChangeStateToNormal<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the state of the player to normal </p> <hr /> </div> <h5>Player_ChangeStateToCustomControls</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_ChangeStateToCustomControls<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asLookInputCallback<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asMoveInputCallback<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asActionInputCallback<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asLeanInputCallback<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the player state so that the normal controls are used for something else. </p> <ul> <li class="level1"> <b>asLookInputCallback</b>: Overrides look controls. If false is returned, normal controls are overridden. Syntax: bool F(const cVector2f &in avLookAmount)</li> <li class="level1"> <b>asMoveInputCallback</b>: Overrides move controls. If false is returned, normal controls are overridden. Syntax: bool F(const cVector2f &in avMoveAmount)</li> <li class="level1"> <b>asActionInputCallback</b>: Overrides action input. If false is returned, normal controls are overridden. Syntax: bool F(int alAction, bool abPressed)</li> <li class="level1"> <b>asLeanInputCallback</b>: Overrides lean input. If false is returned, normal controls are overridden. Syntax: bool F(float afAmount)</li> </ul> <hr /> </div> <h5>Player_GetDefaultEyelineHeight</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetDefaultEyelineHeight<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the player's eyeline height i.e. the height from the foot position to the camera </p> <p> <b>Returns</b>: The distance between the feet and the default eyeline </p> <hr /> </div> <h5>Player_SetCameraUseSmoothing</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCameraUseSmoothing<span class="br0">(</span>bool abValue<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turn on or off camera smoothing. When off, this stops the camera lagging slightly behind the player's movements. </p> <ul> <li class="level1"> <b>abValue</b>: smooth values of the camera or not</li> </ul> <hr /> </div> <h5>Player_StartLookAt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_StartLookAt<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afAcc<span class="sy0">,</span> <span class="kw4">float</span> afSpeedMul<span class="sy0">,</span> <span class="kw4">float</span> afMaxSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Rotate the player camera towards the positon of an entity/area. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity/area to rotate camera towards.</li> <li class="level1"> <b>afAcc</b>: acceleration of the camera movement.</li> <li class="level1"> <b>afSpeedMul</b>: distance towards camera multiplied with this value sets the camera speed.</li> <li class="level1"> <b>afMaxSpeed</b>: maximum speed of camera movement.</li> </ul> <hr /> </div> <h5>Player_StopLookAt</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_StopLookAt<span class="br0">(</span><span class="kw4">float</span> afDeacc<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stop rotating the camera towards a target specified with </p> <ul> <li class="level1"> <b>afDeacc</b>: deacceleration of the camera movement. 0 means 'stop now'</li> </ul> <hr /> </div> <h5>Player_MoveHeadPos</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_MoveHeadPos<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPos<span class="sy0">,</span> <span class="kw4">float</span> afAcc<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="sy0">,</span> <span class="kw4">float</span> afSlowDownDist<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves the position of the camera over time. </p> <ul> <li class="level1"> <b>avPos</b>: target offset from original camera position, relative to the rotation of the player.</li> <li class="level1"> <b>afAcc</b>: acceleration of camera movement.</li> <li class="level1"> <b>afSpeed</b>: target speed of camera movement.</li> <li class="level1"> <b>afSlowDownDist</b>: distance from target where movement starts slowing down.</li> </ul> <hr /> </div> <h5>Player_FadeFOVMulTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeFOVMulTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the FOV Multiplier to a value </p> <ul> <li class="level1"> <b>afX</b>: The FOV to a value, something like 0.001 - 2 are okay values. 1 = default</li> <li class="level1"> <b>afSpeed</b>: The amount of change per second</li> </ul> <hr /> </div> <h5>Player_FadeAspectMulTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeAspectMulTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the Aspect Multiplier to a value. This value represent how much wider the screen than the height. </p> <ul> <li class="level1"> <b>afX</b>: The Aspect to a value, something like 0.2 - 2 are okay values. 1 = default</li> <li class="level1"> <b>afSpeed</b>: The amount of change per second</li> </ul> <hr /> </div> <h5>Player_FadeFOVTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeFOVTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the FOV value. This does NOT affect the FOV multiplier which will still be applied </p> <ul> <li class="level1"> <b>afX</b>: The vertical FOV to a value in radians, -1 = default (the menu displays horzontal FOV which is not the same)</li> <li class="level1"> <b>afSpeed</b>: The amount of change per second</li> </ul> <hr /> </div> <h5>Player_FadeFOVToDefault</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeFOVToDefault<span class="br0">(</span><span class="kw4">float</span> afSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the FOV value to default. This does NOT affect the FOV multiplier </p> <ul> <li class="level1"> <b>afSpeed</b>: The amount of change per second</li> </ul> <hr /> </div> <h5>Player_FadeRollTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_FadeRollTo<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afSpeedMul<span class="sy0">,</span> <span class="kw4">float</span> afMaxSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the camera roll angle. </p> <ul> <li class="level1"> <b>afX</b>: This is the angle of rotation in angles. 0=normal and 180=upside down.</li> <li class="level1"> <b>afSpeedMul</b>: This is used to calculate the speed based on the distance to the goal angle. speed = dist_to_goal * afSpeedMul</li> <li class="level1"> <b>afMaxSpeed</b>: The maximum speed the camera is rotated in</li> </ul> <hr /> </div> <h5>Player_SetRoll</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetRoll<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the camera roll angle. </p> <ul> <li class="level1"> <b>afX</b>: This is the angle of rotation in angles. 0=normal and 180=upside down.</li> </ul> <hr /> </div> <h5>Player_Teleport</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_Teleport<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asStartPosName<span class="sy0">,</span> bool abAlignYaw<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Teleport the player to a specific PlayerStart Area. </p> <ul> <li class="level1"> <b>asStartPosName</b>: name of the PlayerStart Area to teleport to.</li> <li class="level1"> <b>abAlignYaw</b>: if the player yaw should be aligned with the PlayerStart Area's yaw.</li> </ul> <hr /> </div> <h5>Player_PlaceAtEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_PlaceAtEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abAlignYaw<span class="sy0">=</span><span class="kw2">true</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Teleport the player to a specific entity </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity to teleport to.</li> <li class="level1"> <b>abAlignYaw</b>: if the player should be rotated to match the entity's rotation</li> </ul> <hr /> </div> <h5>Player_EnableCameraLock</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_EnableCameraLock<span class="br0">(</span><span class="kw4">float</span> afLocalYawMin<span class="sy0">,</span> <span class="kw4">float</span> afLocalYawMax<span class="sy0">,</span> <span class="kw4">float</span> afLocalPitchMin<span class="sy0">,</span> <span class="kw4">float</span> afLocalPitchMax<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This locks the player's camera based upon the current look direction. Arguments are in degrees and local to the current look direction. </p> <hr /> </div> <h5>Player_DisableCameraLock</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_DisableCameraLock<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Disables the camera lock and makes it go back to normal </p> <hr /> </div> <h5>Player_GetCameraPosition</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetCameraPosition<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the position that the camera should be having at this moment (but might not, if it is doing something else) </p> <hr /> </div> <h5>Player_GetCameraYawPitchRoll</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetCameraYawPitchRoll<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the yaw, pitch and roll for the current player camera </p> <hr /> </div> <h5>Player_AddBodyForce</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_AddBodyForce<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avForce<span class="sy0">,</span> bool abUseLocalCoords<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds force to the player's body. </p> <ul> <li class="level1"> <b>avForce</b>: force added.</li> <li class="level1"> <b>abUseLocalCoords</b>: true = force is added relative to the player's rotation - false = force is added relative to the world.</li> </ul> <hr /> </div> <h5>Player_AddContinuosBodyForce</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_AddContinuosBodyForce<span class="br0">(</span><span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avForce<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds continuous force to the player's body for a certain duration in global space Only support one of this running at one time. </p> <ul> <li class="level1"> <b>avForce</b>: force added.</li> <li class="level1"> <b>afTime</b>: Duration of the force add</li> </ul> <hr /> </div> <h5>_Player_AddContinuosBodyForce_Update</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> _Player_AddContinuosBodyForce_Update<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTimer<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Player_AddBodyForceAwayFromEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_AddBodyForceAwayFromEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntity<span class="sy0">,</span> <span class="kw4">float</span> afForce<span class="sy0">,</span> bool abOnly2D<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afMaxForceSpeed<span class="sy0">=</span><span class="nu0">2</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds force to the player's body away from the specified entity. </p> <ul> <li class="level1"> <b>asEntity</b>: entity to push away from.</li> <li class="level1"> <b>afForce</b>: magnitude of the force added.</li> <li class="level1"> <b>abOnly2D</b>: true = only have into account the x and z values</li> <li class="level1"> <b>afMaxForceSpeed</b>: </li> </ul> <hr /> </div> <h5>Player_GetSpeed</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetSpeed<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the player's speed. </p> <p> <b>Returns</b>: float, the speed of the player's movement, measured in m/s. </p> <hr /> </div> <h5>Player_GetVelocity</h5> <div class="level5"> <pre class="code c++">cVector3f Player_GetVelocity<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the player's velocity. </p> <p> <b>Returns</b>: cVector3f , the velocity of the player. </p> <hr /> </div> <h5>Player_MoveForward</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_MoveForward<span class="br0">(</span><span class="kw4">float</span> afAcc<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves the player character in the direction it's facing. </p> <ul> <li class="level1"> <b>afAcc</b>: acceleration with which to move forward.</li> </ul> <hr /> </div> <h5>Player_GetFocusEntityName</h5> <div class="level5"> <pre class="code c++">tString Player_GetFocusEntityName<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the name of the current entity in focus. Will only returna string when player is in the normal state. </p> <hr /> </div> <h5>Player_GetFocusEntityID</h5> <div class="level5"> <pre class="code c++">tID Player_GetFocusEntityID<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the ID of the current entity in focus. Will return tID_Invalid when player is in the normal state or has no focus entity. </p> <hr /> </div> <h5>Player_IsInteracting</h5> <div class="level5"> <pre class="code c++">bool Player_IsInteracting<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns false if the player is grabbing an object, reading a terminal or a piece of paper etc. etc. </p> <hr /> </div> <h5>Player_SetInteractionAllowed</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetInteractionAllowed<span class="br0">(</span>bool abState<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turn on or off the player's ability to interact with the world. </p> <hr /> </div> <h5>Player_GetInteractionAllowed</h5> <div class="level5"> <pre class="code c++">bool Player_GetInteractionAllowed<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Is the player allowed to interact with the world? </p> <hr /> </div> <h5>Player_IsReading</h5> <div class="level5"> <pre class="code c++">bool Player_IsReading<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Return true if the player is reading a note, terminal or zoom area </p> <hr /> </div> <h5>Player_ShowCrossHairIcons</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_ShowCrossHairIcons<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets whether the crosshair should be drawn or not. </p> <ul> <li class="level1"> <b>abX</b>: true = draw crosshair - false = hide crosshair.</li> </ul> <hr /> </div> <h5>Player_SetCrossHairState</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetCrossHairState<span class="br0">(</span>eCrossHairState alState<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the crosshair state for the player. </p> <ul> <li class="level1"> <b>alState</b>: state to set.</li> </ul> <hr /> </div> <h5>Player_SetFlashlightActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightActive<span class="br0">(</span>bool abX<span class="sy0">,</span> bool abSuppressSound<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns the flashlight on or off. </p> <ul> <li class="level1"> <b>abX</b>: true = flashlight on. - false = flashlight off.</li> <li class="level1"> <b>abSuppressSound</b>: if true don't make a noise</li> </ul> <hr /> </div> <h5>Player_GetFlashlightActive</h5> <div class="level5"> <pre class="code c++">bool Player_GetFlashlightActive<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns if the flashlight is turned on or off </p> <p> <b>Returns</b>: abX, true = flashlight on. - false = flashlight off. </p> <hr /> </div> <h5>Player_GetFlashlightRange</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetFlashlightRange<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the range of the flashlight </p> <p> <b>Returns</b>: afX, Radius of flashlight. </p> <hr /> </div> <h5>Player_SetFlashlightFadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightFadeOut<span class="br0">(</span><span class="kw4">float</span> afSpeed<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> Set the flashlight fade out and ease </p> <ul> <li class="level1"> <b>afSpeed</b>: fade speed</li> <li class="level1"> <b>aEasing</b>: easing method to use</li> </ul> <hr /> </div> <h5>Player_SetFlashlightFadeIn</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightFadeIn<span class="br0">(</span><span class="kw4">float</span> afSpeed<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> Set the flashlight fade in and ease </p> <ul> <li class="level1"> <b>afSpeed</b>: fade speed</li> <li class="level1"> <b>aEasing</b>: easing method to use</li> </ul> <hr /> </div> <h5>Player_SetFlashlightDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Enables or disables toggling flashlight on/off </p> <ul> <li class="level1"> <b>abX</b>: true = flashlight can't be turned on or off. - false = flashlight can be turned on or off.</li> </ul> <hr /> </div> <h5>Player_SetFlashlightOnOffCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightOnOffCallback<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> syntax for callback function, FunctionName(bool abLit). </p> <hr /> </div> <h5>Player_SetFlashlightEnvParticleMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetFlashlightEnvParticleMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set how much the player flashlight should affect env particles </p> <ul> <li class="level1"> <b>afMul</b>: how bright the flashlight should make the env particles</li> </ul> <hr /> </div> <h5>Player_SetAmbientLight</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetAmbientLight<span class="br0">(</span><span class="kw4">float</span> afRadius<span class="sy0">,</span> <span class="kw4">float</span> afBrightness<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Player_SetAmbientLight_None</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetAmbientLight_None<span class="br0">(</span>bool abFade<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns off the ambient light </p> <ul> <li class="level1"> <b>abFade</b>: if the light should fade</li> </ul> <hr /> </div> <h5>Player_SetAmbientLight_Indoors</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetAmbientLight_Indoors<span class="br0">(</span>bool abFade<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets up the ambient light for indoors usage. </p> <ul> <li class="level1"> <b>abFade</b>: if the light should fade</li> </ul> <hr /> </div> <h5>Player_SetAmbientLight_Outdoors</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetAmbientLight_Outdoors<span class="br0">(</span>bool abFade<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets up the ambient light for outdoors usage. </p> <ul> <li class="level1"> <b>abFade</b>: if the light should fade</li> </ul> <hr /> </div> <h5>CameraAnimation_Begin</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CameraAnimation_Begin<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAnimationName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asInteractCallback<span class="sy0">,</span> bool abExitOnLastNode<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Initializes and starts the interactive camera animation state using all nodes in the specified animation. </p> <ul> <li class="level1"> <b>asAnimationName</b>: animation name, the first part of the name of all animation node areas that should be included in the animation.</li> <li class="level1"> <b>asInteractCallback</b>: name of the interact callback, this method is called whenever player interacts with objects while being in camera state. Syntax: void FuncName(const tString &in asEntity)</li> <li class="level1"> <b>abExitOnLastNode</b>: whether the state should automatically end when the animation has hit the final node.</li> </ul> <hr /> </div> <h5>CameraAnimation_End</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CameraAnimation_End<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops the camera animation. Has the same effect as Player_ChangeStateToNormal, but only if the camera animation state is currently active. </p> <hr /> </div> <h5>CameraAnimation_SetAttachedEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CameraAnimation_SetAttachedEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntity<span class="sy0">,</span> bool abAlignYaw<span class="sy0">,</span> bool abAlignPitch<span class="sy0">,</span> bool abAlignRoll<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This attacheds a single entity with the basic transform of the camera (that is player movements not included). </p> <hr /> </div> <h5>CameraAnimation_RemoveAttachedEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CameraAnimation_RemoveAttachedEntity<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>CameraAnimation_GetCurrentPitch</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> CameraAnimation_GetCurrentPitch<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <b>Returns</b>: Current player-applied pitch compared to the viewpoint of the current node. </p> <hr /> </div> <h5>CameraAnimation_GetCurrentYaw</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> CameraAnimation_GetCurrentYaw<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <b>Returns</b>: Current player-applied yaw compared to the viewpoint of the current node. </p> <hr /> </div> <h5>Player_ExitTerminal</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_ExitTerminal<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Player_GetCurrentToolEntityName</h5> <div class="level5"> <pre class="code c++">tString Player_GetCurrentToolEntityName<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the name of the tool entity currently equipped. </p> <p> <b>Returns</b>: tString , the name of the tool entity. An empty string if the player isn't carrying a tool or if the tool doesn't have an entity associated with it. </p> <hr /> </div> <h5>Player_GetCurrentHudEntityName</h5> <div class="level5"> <pre class="code c++">tString Player_GetCurrentHudEntityName<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns the name of the hud entity currently equipped. </p> <p> <b>Returns</b>: tString , the name of the hud entity. An empty string if the player doesn't have a hud entity. </p> <hr /> </div> <h5>Player_ToolIsInInventory</h5> <div class="level5"> <pre class="code c++">bool Player_ToolIsInInventory<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTool<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the specified tool is in the player's inventory. </p> <ul> <li class="level1"> <b>asTool</b>: name of tool entity.</li> </ul> <p> <b>Returns</b>: bool, true if the tool is in the player's inventory. </p> <hr /> </div> <h5>Player_EquipTool</h5> <div class="level5"> <pre class="code c++">bool Player_EquipTool<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTool<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asLookEntities<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Tries to equip a specific tool in the player's inventory. Returns false if the tool isn't in the inventory. </p> <ul> <li class="level1"> <b>asTool</b>: the name of the tool entity to equip.</li> <li class="level1"> <b>asLookEntities</b>: names of the entities (comma separated) that trigger the equipping of the tool when inside the camera view.</li> </ul> <hr /> </div> <h5>Player_ReEquipTool</h5> <div class="level5"> <pre class="code c++">bool Player_ReEquipTool<span class="br0">(</span><span class="kw4">float</span> afTime<span class="sy0">=</span><span class="nu17">0.5f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Tries to equip the tool that was last unequipped. Useful when unequipping something temporarily. Returns false if the tool is no longer in the inventory or no tool has been unequipped. </p> <ul> <li class="level1"> <b>afTime</b>: the time it should take to raise tool. Defaults to 0.5 seconds.</li> </ul> <hr /> </div> <h5>Player_UnequipTool</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_UnequipTool<span class="br0">(</span>bool abRemoveFromInventory<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Unequips the currently carried tool. </p> <ul> <li class="level1"> <b>abRemoveFromInventory</b>: if tool should be removed from inventory when hidden. Defaults to false.</li> </ul> <hr /> </div> <h5>Player_RemoveTool</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_RemoveTool<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asTool<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Removes the specified tool from the player's inventory so it can no longer be equipped. </p> <ul> <li class="level1"> <b>asTool</b>: the name of the tool entity to remove.</li> </ul> <hr /> </div> <h5>Player_RemoveAllTools</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_RemoveAllTools<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Clears the player's inventory. </p> <hr /> </div> <h5>Player_PlayCustomToolAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_PlayCustomToolAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAnim<span class="sy0">,</span> bool abRemoveToolWhenOver<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAnimOverCallback<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This only works if the player is drawing or is holding an item. If you want the hide animation to play after this animation is done, call Player_UnequipTool after calling this and amkes sure abRemoveToolWhenOver is false. </p> <ul> <li class="level1"> <b>asAnim</b>: the name of the animaiton to play</li> <li class="level1"> <b>abRemoveToolWhenOver</b>: If the tool should be removed when this animaiton has finished playing.</li> <li class="level1"> <b>asAnimOverCallback</b>: played when the animation is over. syntax: void f(const tString& in asAnim)</li> </ul> <hr /> </div> <h5>Player_PickupProp</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_PickupProp<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asPropName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallback<span class="sy0">,</span> <span class="kw4">const</span> <span class="kw4">float</span> afTimeToPickup<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Initializes and starts a "pickup" animation for a the prop passed as argument. </p> <ul> <li class="level1"> <b>asPropName</b>: name of the prop that will be animated.</li> <li class="level1"> <b>asCallback</b>: name of the function that will be called when animation is done. Syntax "void MyFunc(const tString &in asEntity)".</li> <li class="level1"> <b>afTimeToPickup</b>: the total time of the animation.</li> </ul> <hr /> </div> <h5>Player_SetHealth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetHealth<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the player's health. If at 0 or below, then Player becomes dead. </p> <hr /> </div> <h5>Player_GetHealth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetHealth<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the health of the player </p> <hr /> </div> <h5>Player_AddHealth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_AddHealth<span class="br0">(</span><span class="kw4">float</span> afX<span class="sy0">,</span> <span class="kw4">float</span> afMinValue<span class="sy0">=-</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds a value to the player's health. If at 0 or below, then Player becomes dead. </p> <hr /> </div> <h5>Player_SetMaxHealth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetMaxHealth<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the player's maximum health. </p> <hr /> </div> <h5>Player_GetMaxHealth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Player_GetMaxHealth<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the max health of the player </p> <hr /> </div> <h5>Player_GiveDamage</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_GiveDamage<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afMinHealth<span class="sy0">,</span> eDamageType aType<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asSource<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gives damage to the player which applies a damage effect </p> <ul> <li class="level1"> <b>afAmount</b>: how much damage to do to the player</li> <li class="level1"> <b>afMinHealth</b>: the minimum health the damage can make</li> <li class="level1"> <b>aType</b>: the type of damage, which damage effect should be applied to the screen</li> <li class="level1"> <b>asSource</b>: the name of the entity doing the damage</li> </ul> <hr /> </div> <h5>Player_IsDead</h5> <div class="level5"> <pre class="code c++">bool Player_IsDead<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Returns true if the player is dead. </p> <p> <b>Returns</b>: bool, true if player is dead. </p> <hr /> </div> <h5>Player_SetPitchLimits</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetPitchLimits<span class="br0">(</span><span class="kw4">float</span> afMin<span class="sy0">,</span> <span class="kw4">float</span> afMax<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Restrict the camera's pitch (vs. world axes) - use 0,0 to turn off </p> <hr /> </div> <h5>Player_SetYawLimits</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetYawLimits<span class="br0">(</span><span class="kw4">float</span> afMin<span class="sy0">,</span> <span class="kw4">float</span> afMax<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Restrict the camera's yaw (vs. world axes) - use 0,0 to turn off </p> <hr /> </div> <h5>Player_GetPitchLimits</h5> <div class="level5"> <pre class="code c++">cVector2f Player_GetPitchLimits<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Return the camera's pitch limits (vs. world axes) as a vector - x=min, y=max </p> <hr /> </div> <h5>Player_GetYawLimits</h5> <div class="level5"> <pre class="code c++">cVector2f Player_GetYawLimits<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Return the camera's yaw limits (vs. world axes) as a vector - x=min, y=max </p> <hr /> </div> <h5>Player_SetLadderMoveMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_SetLadderMoveMul<span class="br0">(</span><span class="kw4">float</span> afMul<span class="sy0">=</span><span class="nu16">1.0</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Player_StopDatamining</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Player_StopDatamining<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div>