GetNpcData - Revision history

QCherry: Document G1R:MP 0.1.2 navigation collision API

2026-09-04T13:52:40Z

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>ownerResource</code>, <code>name</code>, <code>skin</code>, <code>armor</code>, <code>weapon</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>speed</code>, <code>routeIndex</code>, <code>routeCount</code>, <code>routeLoop</code>, <code>routeActive</code>, <code>paused</code>, <code>nameplateIdVisible</code>, <code>obstacleBehavior</code>, and <code>~~navigationMode~~</code>; otherwise returns <code>false</code>.		Returns a table containing <code>id</code>, <code>ownerResource</code>, <code>name</code>, <code>skin</code>, <code>armor</code>, <code>weapon</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>speed</code>, <code>routeIndex</code>, <code>routeCount</code>, <code>routeLoop</code>, <code>routeActive</code>, <code>paused</code>, <code>nameplateIdVisible</code>, <code>obstacleBehavior</code>, <code>navigationMode</code>, and <code>navigationCollisionMode</code>; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
Line 34:		Line 34:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Position and speed values use metres and metres per second; yaw uses degrees.		* Position and speed values use metres and metres per second; yaw uses degrees.
	* <code>obstacleBehavior</code> is <code>"wait"</code> or <code>"avoid"</code>, ~~and~~ <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>.		* <code>obstacleBehavior</code> is <code>"wait"</code> or <code>"avoid"</code>, <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>, and <code>navigationCollisionMode</code> is <code>"combined"</code>, <code>"builtin"</code>, or <code>"custom"</code>.
	* Mutating functions accept only NPCs owned by the calling resource.		* Mutating functions accept only NPCs owned by the calling resource.

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

2026-09-03T18:40:30Z

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: getNpcData. -->~~
	= getNpcData =		= getNpcData =
			<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 scripted NPC.		Returns the complete authoritative state of a scripted NPC.

Line 16:		Line 20:

	== Returns ==		== Returns ==
	Returns a table containing ~~identity~~, ~~owner resource~~, skin, armor, weapon, ~~position~~, yaw, speed, ~~route progress~~ and ~~pause state~~; otherwise returns <code>false</code>.		Returns a table containing <code>id</code>, <code>ownerResource</code>, <code>name</code>, <code>skin</code>, <code>armor</code>, <code>weapon</code>, <code>x</code>, <code>y</code>, <code>z</code>, <code>yaw</code>, <code>speed</code>, <code>routeIndex</code>, <code>routeCount</code>, <code>routeLoop</code>, <code>routeActive</code>, <code>paused</code>, <code>nameplateIdVisible</code>, <code>obstacleBehavior</code>, and <code>navigationMode</code>; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
Line 30:		Line 34:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Position and speed values use metres and metres per second; yaw uses degrees.		* Position and speed values use metres and metres per second; yaw uses degrees.
			* <code>obstacleBehavior</code> is <code>"wait"</code> or <code>"avoid"</code>, and <code>navigationMode</code> is <code>"builtin"</code> or <code>"scripted"</code>.
	* Mutating functions accept only NPCs owned by the calling resource.		* Mutating functions accept only NPCs owned by the calling resource.

QCherry: Complete Lua function catalog

2026-08-15T09:52:47Z

Complete Lua function catalog

← Older revision		Revision as of 09:52, 15 August 2026
Line 32:		Line 32:
	* Mutating functions accept only NPCs owned by the calling resource.		* Mutating functions accept only NPCs owned by the calling resource.

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

QCherry: Update Lua API reference

2026-08-15T09:48:35Z

Update Lua API reference

New page

= getNpcData =
Returns the complete authoritative state of a scripted NPC.

== Syntax ==
<syntaxhighlight lang="lua">
table|false getNpcData(int npcId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>npcId</code> || <code>int</code> || yes || The server-assigned NPC identifier returned by <code>spawnNpc</code> or <code>getNpcs</code>.
|}

== Returns ==
Returns a table containing identity, owner resource, skin, armor, weapon, position, yaw, speed, route progress and pause state; otherwise returns <code>false</code>.

== Examples ==
Read the current route state:
<syntaxhighlight lang="lua" line>
local npc = getNpcData(npcId)
if npc then
outputDebugString(("Route %d/%d"):format(npc.routeIndex, npc.routeCount))
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Position and speed values use metres and metres per second; yaw uses degrees.
* Mutating functions accept only NPCs owned by the calling resource.

[[Category:Server Functions]]
[[Category:World Functions]]
[[Category:NPC Functions]]