QCherry: Document new NPC/player-mode API and events available from 0.1.5

2026-09-25T17:14:35Z

Document new NPC/player-mode API and events available from 0.1.5

← Older revision		Revision as of 17:14, 25 September 2026
Line 40:		Line 40:
	[[Category:World Functions]]		[[Category:World Functions]]
	[[Category:Navigation Functions]]		[[Category:Navigation Functions]]

			<!-- npc015:start -->
			== Additional field since 0.1.5 ==
			The existing table additionally includes blocksSight (boolean). See [[setAiNavigationBlockerBlocksSight]].
			<!-- npc015:end -->

QCherry: Document G1R:MP 0.1.2 navigation collision API

2026-09-04T13:52:28Z

Document G1R:MP 0.1.2 navigation collision API

New page

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

Returns the canonical geometry and state of one blocker owned by the calling resource.

== Syntax ==
<syntaxhighlight lang="lua">
table|false getAiNavigationBlockerData(string blockerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>blockerId</code> || <code>string</code> || yes || The opaque decimal identifier returned by <code>createAiNavigationBlocker</code>. Keep it as a string.
|}

== Returns ==
Returns <code>id</code>, <code>ownerResource</code>, <code>enabled</code>, <code>shape="polygon"</code>, <code>points</code>, <code>minZ</code>, and <code>maxZ</code>, or <code>false</code> for an unknown, invalid or foreign ID.

== Examples ==
Inspect a blocker's canonical footprint:
<syntaxhighlight lang="lua" line>
local data = getAiNavigationBlockerData(blockerId)
if data then
outputDebugString("vertices=" .. tostring(#data.points))
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Box and cylinder inputs are returned as their conservative canonical convex polygon, so the returned <code>shape</code> is always <code>"polygon"</code>.
* Coordinates are converted back to metres. A resource cannot inspect another resource's blockers through this function.

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

GetAiNavigationBlockerData - Revision history

QCherry: Document new NPC/player-mode API and events available from 0.1.5

QCherry: Document G1R:MP 0.1.2 navigation collision API