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

2026-09-03T18:40:09Z

Document Lua APIs available or improved from G1R:MP 0.1.2

New page

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

Assigns one direct, collision-checked movement goal to a resource-owned ground monster in scripted navigation mode.

== Syntax ==
<syntaxhighlight lang="lua">
bool setMonsterMoveGoal(string monsterId, number x, number y, number z [, table options])
</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>x</code> || <code>number</code> || yes || Goal X coordinate in metres.
|-
| <code>y</code> || <code>number</code> || yes || Goal Y coordinate in metres.
|-
| <code>z</code> || <code>number</code> || yes || Ground-location Z reference in metres.
|-
| <code>options</code> || <code>table</code> || no || Optional <code>{ speedScale = number, arrivalRadius = number }</code>. <code>speedScale</code> must be greater than 0 and no greater than 1 and defaults to 1. <code>arrivalRadius</code> is measured in metres, must be 0.01-5, and defaults to 0.2.
|}

== Returns ==
Returns <code>true</code> when the complete goal is accepted; otherwise returns <code>false</code>.

== Examples ==
Walk directly toward a scripted guard position at half catalog speed:
<syntaxhighlight lang="lua" line>
setMonsterNavigationMode(monsterId, "scripted")
setMonsterMoveGoal(monsterId, 25.0, 12.0, 3.0, {
speedScale = 0.5,
arrivalRadius = 0.25,
})
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Only the owning resource may set a goal, and the monster must be alive, ground-following and already in <code>"scripted"</code> mode.
* The goal is a direct segment. Scripted mode does not invoke built-in path finding, avoidance, automatic detours, return-home movement or formation positioning.
* Static world blockers and authoritative player, NPC and monster capsules remain hard constraints. A blocked goal is retained and retried; the server never walks through a blocker.
* The owning resource receives one <code>onMonsterMoveBlocked</code> edge when continuous blockage begins and one <code>onMonsterMoveComplete</code> event when the arrival radius is reached.
* Movement is ground-only. The Z value must describe a plausible nearby ground location; this API does not control flying, vertical velocity or moving platforms.
* Target selection and authoritative attacks continue while navigation is scripted, although built-in movement toward the target is bypassed.

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

SetMonsterMoveGoal - Revision history

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