https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=TestNpcMoveTestNpcMove - Revision history2026-09-19T06:22:14ZRevision history for this page on the wikiMediaWiki 1.46.0https://g1r-mp.com/wiki/index.php?title=TestNpcMove&diff=714&oldid=prevQCherry: Document Lua APIs available or improved from G1R:MP 0.1.22026-09-03T18:40:21Z<p>Document Lua APIs available or improved from G1R:MP 0.1.2</p>
<p><b>New page</b></p><div>= testNpcMove =<br />
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"><br />
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.2</div><br />
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.</div><br />
</div><br />
<br />
Tests a direct NPC move against the current authoritative world and character collision state without changing movement.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
table|false testNpcMove(int npcId, number x, number y, number z)<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Required !! Description<br />
|-<br />
| <code>npcId</code> || <code>int</code> || yes || The server-assigned NPC identifier returned by <code>spawnNpc</code> or <code>getNpcs</code>.<br />
|-<br />
| <code>x</code> || <code>number</code> || yes || Test destination X coordinate in metres.<br />
|-<br />
| <code>y</code> || <code>number</code> || yes || Test destination Y coordinate in metres.<br />
|-<br />
| <code>z</code> || <code>number</code> || yes || Test ground-location Z reference in metres.<br />
|}<br />
<br />
== Returns ==<br />
Returns a table with <code>allowed</code>, <code>reason</code>, <code>blockerType</code> and <code>blockerId</code>, or <code>false</code> when the arguments, ownership or service are invalid. Reasons are <code>clear</code>, <code>unknown-npc</code>, <code>invalid-input</code>, <code>distance-limit</code>, <code>world-collision</code> or <code>dynamic-collision</code>. Blocker types are <code>none</code>, <code>world</code>, <code>player</code>, <code>npc</code>, <code>monster</code> or <code>unknown</code>; <code>blockerId</code> is an identifier string and is empty when no dynamic entity is identified.<br />
<br />
== Examples ==<br />
Inspect a direct goal before assigning it:<br />
<syntaxhighlight lang="lua" line><br />
local result = testNpcMove(npcId, 20.0, -7.5, 2.0)<br />
if result and result.allowed then<br />
setNpcMoveGoal(npcId, 20.0, -7.5, 2.0)<br />
elseif result then<br />
outputDebugString(result.reason .. " blocker=" .. result.blockerType .. ":" .. result.blockerId)<br />
end<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Available only in server-side resource scripts.<br />
* Only the resource that created the NPC may test its movement.<br />
* This is a read-only, ground-only direct-segment test. It does not run route path finding, mutate a goal or provide moving-platform vertical control.<br />
* World and dynamic occupancy may change after the test. <code>setNpcMoveGoal</code> and every simulation step still perform authoritative validation.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Server Functions]]<br />
[[Category:World Functions]]<br />
[[Category:NPC Functions]]</div>QCherry