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

2026-09-03T18:40:08Z

Document Lua APIs available or improved from G1R:MP 0.1.2

New page

= setMonsterNavigationMode =
<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 or resource-scripted movement for a resource-owned monster.

== Syntax ==
<syntaxhighlight lang="lua">
bool setMonsterNavigationMode(string monsterId, string mode)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>monsterId</code> || <code>string</code> || yes || The opaque decimal monster identifier returned by <code>spawnMonster</code> or <code>getMonsters</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 ==
Give a resource direct movement control over a ground monster:
<syntaxhighlight lang="lua" line>
if setMonsterNavigationMode(monsterId, "scripted") then
setMonsterMoveGoal(monsterId, 25.0, 12.0, 3.0)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Only the resource that created the monster may change its navigation mode.
* New monsters start in <code>"builtin"</code> mode. Built-in mode keeps the normal server pathing, avoidance, pursuit, return-home and formation movement.
* In <code>"scripted"</code> mode, direct resource goals replace those built-in movement decisions. The server still owns collision, targeting, attacks, damage, health and death; this function never makes movement or combat client-authoritative.
* Changing between modes stops the monster and clears both its current direct move goal and any built-in movement command. Repeating the current mode is a successful no-op.
* Scripted navigation is ground-only and is rejected for flying monster types. It does not provide flying, arbitrary vertical control or moving-platform attachment.

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

SetMonsterNavigationMode - Revision history

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