https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=SetNpcMoveGoalSetNpcMoveGoal - Revision history2026-09-19T06:33:50ZRevision history for this page on the wikiMediaWiki 1.46.0https://g1r-mp.com/wiki/index.php?title=SetNpcMoveGoal&diff=712&oldid=prevQCherry: Document Lua APIs available or improved from G1R:MP 0.1.22026-09-03T18:40:17Z<p>Document Lua APIs available or improved from G1R:MP 0.1.2</p>
<p><b>New page</b></p><div>= setNpcMoveGoal =<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 />
Assigns one direct, collision-checked movement goal to a resource-owned NPC in scripted navigation mode.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
bool setNpcMoveGoal(int npcId, number x, number y, number z [, table options])<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 || Goal X coordinate in metres.<br />
|-<br />
| <code>y</code> || <code>number</code> || yes || Goal Y coordinate in metres.<br />
|-<br />
| <code>z</code> || <code>number</code> || yes || Ground-location Z reference in metres.<br />
|-<br />
| <code>options</code> || <code>table</code> || no || Optional <code>{ speed = number, arrivalRadius = number }</code>. <code>speed</code> is measured in metres per second, must be 0.1-12, and defaults to 1. <code>arrivalRadius</code> is measured in metres, must be 0.01-5, and defaults to 0.2.<br />
|}<br />
<br />
== Returns ==<br />
Returns <code>true</code> when the complete goal is accepted; otherwise returns <code>false</code>.<br />
<br />
== Examples ==<br />
Move an NPC directly toward a work point:<br />
<syntaxhighlight lang="lua" line><br />
setNpcNavigationMode(npcId, "scripted")<br />
setNpcMoveGoal(npcId, 20.0, -7.5, 2.0, {<br />
speed = 1.5,<br />
arrivalRadius = 0.25,<br />
})<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Available only in server-side resource scripts.<br />
* Only the owning resource may set a goal, and the NPC must already be in <code>"scripted"</code> mode.<br />
* The goal is a direct segment. Scripted mode does not run route path finding, <code>wait</code>/<code>avoid</code> behavior or automatic detours.<br />
* Static world blockers and authoritative player, NPC and monster capsules remain hard constraints. A blocked goal remains active and resumes only after a valid direct step becomes available.<br />
* The owning resource receives one <code>onNpcMoveBlocked</code> edge when continuous blockage begins and one <code>onNpcMoveComplete</code> event when the arrival radius is reached.<br />
* Movement is ground-only. The Z value must describe a plausible nearby ground location; this API does not control vertical velocity or moving platforms.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Server Functions]]<br />
[[Category:World Functions]]<br />
[[Category:NPC Functions]]</div>QCherry