GetMonsterData - Revision history

QCherry: Document G1R:MP 0.1.2 navigation collision API

2026-09-04T13:52:38Z

Document G1R:MP 0.1.2 navigation collision API

← Older revision		Revision as of 13:52, 4 September 2026
Line 20:		Line 20:

	== Returns ==		== Returns ==
	Returns a table containing <code>id</code>, <code>type</code>, <code>name</code>, <code>nameplateIdVisible</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>health</code>, <code>maxHealth</code>, <code>attackDamage</code>, <code>state</code>, <code>targetPlayerId</code>, <code>aggressive</code>, <code>alive</code>, and <code>~~navigationMode~~</code>; otherwise returns <code>false</code>.		Returns a table containing <code>id</code>, <code>type</code>, <code>name</code>, <code>nameplateIdVisible</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>health</code>, <code>maxHealth</code>, <code>attackDamage</code>, <code>state</code>, <code>targetPlayerId</code>, <code>aggressive</code>, <code>alive</code>, <code>navigationMode</code>, and <code>navigationCollisionMode</code>; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
Line 33:		Line 33:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Position values use metres and yaw uses degrees. <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>.		* Position values use metres and yaw uses degrees. <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>; <code>navigationCollisionMode</code> is <code>"combined"</code>, <code>"builtin"</code>, or <code>"custom"</code>.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]

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

2026-09-03T18:40:28Z

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: getMonsterData. -->~~
	= getMonsterData =		= getMonsterData =
			<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>

	Returns the complete authoritative state of a server-owned monster.		Returns the complete authoritative state of a server-owned monster.

Line 16:		Line 20:

	== Returns ==		== Returns ==
	Returns a table containing <code>id</code>, <code>type</code>, ~~position~~, yaw, health, ~~maximum health~~, state, ~~target player~~, ~~aggression~~, and ~~alive state~~; otherwise returns <code>false</code>.		Returns a table containing <code>id</code>, <code>type</code>, <code>name</code>, <code>nameplateIdVisible</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>health</code>, <code>maxHealth</code>, <code>attackDamage</code>, <code>state</code>, <code>targetPlayerId</code>, <code>aggressive</code>, <code>alive</code>, and <code>navigationMode</code>; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
Line 29:		Line 33:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Position values use metres and yaw uses degrees.		* Position values use metres and yaw uses degrees. <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]

QCherry: Complete Lua function catalog

2026-08-15T09:52:39Z

Complete Lua function catalog

← Older revision		Revision as of 09:52, 15 August 2026
Line 31:		Line 31:
	* Position values use metres and yaw uses degrees.		* Position values use metres and yaw uses degrees.

			[[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:25:25Z

Document server-owned monsters and interactions

New page

= getMonsterData =
Returns the complete authoritative state of a server-owned monster.

== Syntax ==
<syntaxhighlight lang="lua">
table|false getMonsterData(string monsterId)
</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>.
|}

== Returns ==
Returns a table containing <code>id</code>, <code>type</code>, position, yaw, health, maximum health, state, target player, aggression, and alive state; otherwise returns <code>false</code>.

== Examples ==
Inspect a monster:
<syntaxhighlight lang="lua" line>
local monster = getMonsterData(monsterId)
if monster then
outputDebugString(monster.type .. " HP: " .. monster.health .. "/" .. monster.maxHealth)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Position values use metres and yaw uses degrees.

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