View source for StopNpcMovement

= stopNpcMovement =
<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;">AVAILABLE FROM UPDATE 0.1.2</div>
<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>
</div>

Stops a resource-owned NPC and clears its current route or direct movement goal without changing its navigation mode.

== Syntax ==
<syntaxhighlight lang="lua">
bool stopNpcMovement(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 <code>true</code> when the stop is accepted; otherwise returns <code>false</code>.

== Examples ==
Stop an NPC at its current position:
<syntaxhighlight lang="lua" line>
stopNpcMovement(npcId)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Only the resource that created the NPC may stop it.
* The function clears both route state and a scripted direct goal, publishes a reliable stationary state, and leaves <code>navigationMode</code> unchanged.
* An explicit stop does not emit <code>onNpcMoveComplete</code>. Use <code>setNpcRoute</code> or <code>setNpcMoveGoal</code> to start movement again in the matching mode.

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