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

2026-09-08T23:51:03Z

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

New page

= onClientCameraReset =
<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 event is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Notifies an affected client resource that its camera ownership, cached state or pending requests have been forcibly invalidated.

== Availability ==
This event is available in '''client-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onClientCameraReset(string errorText, string stateJson)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>errorText</code> || <code>string</code> || Reason for the forced reset or invalidation, such as a connection/world/local-character change.
|-
| <code>stateJson</code> || <code>string</code> || Optional JSON snapshot. It can be empty, notably on IPC disconnect; do not assume it is valid JSON or a ready camera state.
|}

== Examples ==
Cancel your own pending cinematic state when camera ownership is lost.
<syntaxhighlight lang="lua" line>
local pendingMove
local cinematicTimer
addEventHandler("onClientCameraReset", resourceRoot, function(errorText, stateJson)
pendingMove = nil
if cinematicTimer then
killTimer(cinematicTimer)
cinematicTimer = nil
end
outputDebugString("Camera control ended: " .. tostring(errorText))
-- Do not immediately reacquire: wait until the world/spawn is ready again.
end)
</syntaxhighlight>

== Notes ==
* Built-in local client event delivered to resourceRoot; it is not a remotely triggerable server callback. Native forced cleanup targets the camera owner; IPC disconnect notifies all affected resources with cached state or pending requests, including query-only resources.
* Resource ownership, pending requests and cached snapshots are invalidated before this callback. Do not continue an old path from an old requestId.
* The event covers forced native lifecycle cleanup and IPC connection invalidation. A disconnect notification does not guarantee a newly rendered restored view at that instant.
* An explicit resetCameraPos command is acknowledged by [[onClientCameraCommandResult]] with phase reset; do not wait for this forced-reset event to complete an ordinary reset.
* World readiness and spawn completion must be re-established before requesting a new camera sequence. See [[Scripted camera]].

[[Category:Lua Events]]
[[Category:Client Events]]

OnClientCameraReset - Revision history

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