Player::setHealthRechargeMultiplier: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
(Function has to be called per render (verified by several people on #deutsch))
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
NOTICE: After changing the local model (mp.players.local.model), this function must be called again
This function has to be called once per render.


==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">player.setHealthRechargeMultiplier(regenRate);</syntaxhighlight>
<pre>mp.game.player.setHealthRechargeMultiplier(regenRate);</pre>
 
=== Required Arguments ===
=== Required Arguments ===
*'''regenRate:''' float
*'''regenRate:''' float
===Return value===
===Return value===
*'''Undefined'''
*'''Undefined'''
==Example==
==Example==
<syntaxhighlight lang="javascript">
{{ClientsideCode|
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<pre>
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
mp.events.add('render', () => {
<syntaxhighlight lang="javascript" highlight="5">
 
mp.events.add('guiReady', () => {


     // remove health regeneration
     // remove health regeneration
Line 21: Line 23:


});
});
</pre>
}}


</syntaxhighlight>
</div>
</syntaxhighlight>
==See also==
==See also==
{{Player_function_c}}
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]
[[Category:TODO: Example]]

Latest revision as of 10:50, 14 December 2018

NOTICE: After changing the local model (mp.players.local.model), this function must be called again This function has to be called once per render.

Syntax

mp.game.player.setHealthRechargeMultiplier(regenRate);

Required Arguments

  • regenRate: float

Return value

  • Undefined

Example

Client-Side
mp.events.add('render', () => {

    // remove health regeneration
    mp.game.player.setHealthRechargeMultiplier(0.0);

    // set health regeneration to default
    mp.game.player.setHealthRechargeMultiplier(1.0);

});

See also