SetMonsterHealth
setMonsterHealth
IMPROVED FROM UPDATE 0.1.2
This function is available in earlier releases and has corrected or expanded behavior in G1R:MP 0.1.2 and later. The contract below describes the updated behavior.
Sets a monster's authoritative health.
Syntax
bool setMonsterHealth(string monsterId, number health)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
monsterId |
string |
yes | The opaque decimal monster identifier returned by spawnMonster or getMonsters.
|
health |
number |
yes | The non-negative health value to apply. |
Returns
Returns true when the value is accepted; otherwise returns false. Values above the monster's current maximum health are rejected.
Examples
Restore a monster to full health:
local health, maximum = getMonsterHealth(monsterId)
setMonsterHealth(monsterId, maximum)
Notes
- Available only in server-side resource scripts.
- Setting health to zero transitions the monster into the server-owned death state.