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

2026-09-03T18:40:16Z

Document Lua APIs available or improved from G1R:MP 0.1.2

New page

= setNpcNavigationMode =
<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>

Selects built-in route movement or direct resource-scripted movement for a resource-owned NPC.

== Syntax ==
<syntaxhighlight lang="lua">
bool setNpcNavigationMode(int npcId, string mode)
</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>.
|-
| <code>mode</code> || <code>string</code> || yes || Case-sensitive movement mode: <code>"builtin"</code> or <code>"scripted"</code>.
|}

== Returns ==
Returns <code>true</code> when the requested mode is valid and accepted; otherwise returns <code>false</code>.

== Examples ==
Take direct control of an NPC's movement:
<syntaxhighlight lang="lua" line>
if setNpcNavigationMode(npcId, "scripted") then
setNpcMoveGoal(npcId, 20.0, -7.5, 2.0)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Only the resource that created the NPC may change its navigation mode.
* New NPCs start in <code>"builtin"</code> mode, where <code>setNpcRoute</code>, server path planning and the selected <code>wait</code>/<code>avoid</code> behavior remain available.
* In <code>"scripted"</code> mode, direct resource goals bypass built-in route following, path planning and avoidance. Static world blockers and authoritative character-capsule collision remain mandatory.
* Changing between modes stops the NPC and clears both its current route and direct move goal. Repeating the current mode is a successful no-op.
* The mode changes movement only. It does not grant client authority or bypass server-owned combat, health or other gameplay rules.
* Scripted NPC movement is ground-only and does not provide arbitrary vertical control or moving-platform attachment.

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

SetNpcNavigationMode - Revision history

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