QCherry: Document scripted camera API and events available from G1R:MP 0.1.3

2026-09-08T23:50:47Z

Document scripted camera API and events available from G1R:MP 0.1.3

New page

= getCameraPos =
<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.3</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Returns the last acknowledged camera position cached for this client resource.

== Syntax ==
<syntaxhighlight lang="lua">
table|false getCameraPos()
</syntaxhighlight>

== Parameters ==
This function does not accept parameters.

== Returns ==
A table <code>{x,y,z}</code> in metres, or <code>false</code> when no ready acknowledged camera state is available.

== Examples ==
Client-side: request a fresh snapshot and read it inside the matching callback.
<syntaxhighlight lang="lua" line>
-- Client-side: run after the local world and player camera are ready.
local query
addEventHandler("onClientCameraCommandResult", resourceRoot,
function(requestId, ok, phase, errorText, stateJson)
if requestId ~= query then return end
query = nil
if not ok or phase ~= "state" then
outputDebugString("Camera query failed: " .. tostring(errorText), 2)
return
end
local state = getCameraState()
if not state or not state.ready then return end
local position = getCameraPos()
if position then outputDebugString(("Camera: %.2f %.2f %.2f"):format(position.x, position.y, position.z)) end
end)
query = requestCameraState()
if not query then outputDebugString("Camera query was not queued", 2) end
</syntaxhighlight>

== Notes ==
* Client-side resource scripts only. Equivalent PascalCase spelling: <code>GetCameraPos</code>. There is no server-side version.
* This getter reads a per-resource cache, not the engine synchronously. [[requestCameraState]] refreshes it asynchronously without taking camera ownership.
* A validated response updates the cache before [[onClientCameraCommandResult]] is dispatched. The cache is invalidated on lifecycle/connection changes.
* A command's immediate applied/completed snapshot can precede the next rendered camera update. Request state after another frame or short timer to observe the updated view. See [[Scripted camera]] for field meanings and timing.

[[Category:Lua Functions]]
[[Category:Client Functions]]
[[Category:Camera Functions]]

GetCameraPos - Revision history

QCherry: Document scripted camera API and events available from G1R:MP 0.1.3