Skip to content

Commit

Permalink
tweak(natives/player): document that the recharge multiplier gets res…
Browse files Browse the repository at this point in the history
…et on player ped change (#1156)
  • Loading branch information
AvarianKnight authored Aug 9, 2024
1 parent 365ba86 commit c3b80a5
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions PLAYER/SetPlayerHealthRechargeMultiplier.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ ns: PLAYER
void SET_PLAYER_HEALTH_RECHARGE_MULTIPLIER(Player player, float regenRate);
```
This multiplier is reset to `1.0` every time the player ped is changed, often times via [`SET_PLAYER_MODEL`](#_0x00A1CADD00108836) or [`CHANGE_PLAYER_PED`](#_0x048189FAC643DEEE).
## Parameters
* **player**: The local player ID, see [PLAYER_ID](#_0x4F8644AF03D0E0D6).
* **regenRate**: The recharge multiplier, this value needs to be a positive float value to work.
## Examples
```lua
-- To disable the health recharge completely:
Expand All @@ -17,6 +23,3 @@ SetPlayerHealthRechargeMultiplier(PlayerId(), 0.0)
SetPlayerHealthRechargeMultiplier(PlayerId(), 1.0)
```

## Parameters
* **player**: The local player ID.
* **regenRate**: The recharge multiplier, a value between 0.0 and 1.0.

0 comments on commit c3b80a5

Please sign in to comment.