SetMonsterHealth - Revision history

QCherry: Document Lua APIs available or improved from G1R:MP 0.1.2

2026-09-03T18:40:31Z

Document Lua APIs available or improved from G1R:MP 0.1.2

← Older revision		Revision as of 18:40, 3 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: setMonsterHealth. -->~~
	= setMonsterHealth =		= setMonsterHealth =
			<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
			<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">IMPROVED FROM UPDATE 0.1.2</div>
			<div style="color:#111111; margin-top:0.25rem;">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.</div>
			</div>

	Sets a monster's authoritative health.		Sets a monster's authoritative health.

Line 18:		Line 22:

	== Returns ==		== Returns ==
	Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.		Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>. Values above the monster's current maximum health are rejected.

	== Examples ==		== Examples ==

QCherry: Complete Lua function catalog

2026-08-15T09:55:03Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 31:		Line 31:
	* Setting health to zero transitions the monster into the server-owned death state.		* Setting health to zero transitions the monster into the server-owned death state.

			[[Category:Lua Functions]]
	[[Category:Server Functions]]		[[Category:Server Functions]]
	[[Category:World Functions]]		[[Category:World Functions]]
	[[Category:Monster Functions]]		[[Category:Monster Functions]]

QCherry: Document server-owned monsters and interactions

2026-08-14T04:26:04Z

Document server-owned monsters and interactions

New page

= setMonsterHealth =
Sets a monster's authoritative health.

== Syntax ==
<syntaxhighlight lang="lua">
bool setMonsterHealth(string monsterId, number health)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>monsterId</code> || <code>string</code> || yes || The opaque decimal monster identifier returned by <code>spawnMonster</code> or <code>getMonsters</code>.
|-
| <code>health</code> || <code>number</code> || yes || The non-negative health value to apply.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Restore a monster to full health:
<syntaxhighlight lang="lua" line>
local health, maximum = getMonsterHealth(monsterId)
setMonsterHealth(monsterId, maximum)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Setting health to zero transitions the monster into the server-owned death state.

[[Category:Server Functions]]
[[Category:World Functions]]
[[Category:Monster Functions]]