SetNpcMaxHealth
setNpcMaxHealth
AVAILABLE FROM UPDATE 0.1.5
This function is available in G1R:MP 0.1.5 and later. The contract below includes the compatibility guarantees introduced in that update.
Sets NPC maximum health.
Syntax
setNpcMaxHealth(npcId, maxHealth)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
npcId |
int |
yes | Server-assigned NPC ID returned by spawnNpc; not a player ID. |
maxHealth |
number |
yes | Finite 1..100000; lowering clamps current HP, raising does not heal. |
Returns
Returns true when accepted, false for a rejected request. Acceptance is not proof of a rendered animation, projectile release or hit.
Examples
setNpcMaxHealth(npcId, 100)
Notes
- Server-side only. Mutations require the NPC to belong to the calling resource; getters do not grant control.
- Since 0.1.5. This documents the next release; public 0.1.4 does not include these additions.
- Use matching updated client and server. See NPC scripting for lifecycle, defaults, combat examples and collision limitations.
- Changing maxHP does not automatically heal. Script HP is separate from armor protection.