Skip to content
San Andreas Online Docs

releaseScriptCamera

Client-side
SA:O APINative script camera

Restores captured gameplay camera state and optionally leaves a successful scene under its black fade.

Syntax

bool releaseScriptCamera(int token [, bool preserveFade = false])

Arguments

tokenint

Current lease generation token.

preserveFadebooloptional · default false

Keep the fade black so gameplay can fade in after restoration.

Returns

true when the calling resource released its current generation; false for stale or foreign tokens.

Ownership and lifecycle

Only one resource can own the global script camera. San Andreas Online rejects stale callbacks and releases ownership on stop, restart, disconnect, or an authoritative server camera RPC.

Where this comes from

SOURCECLuaCameraDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaCameraDefs.cpp INTRODUCED / EXTENDED8cf6cc3cbRead the commit and why the change was made RELATED CATEGORY HARNESS native-script-camera-test Category-level coverage · test-resources/native-script-camera-test
RELATED SA:O APIS

Continue exploring

Read the system guide →
acquireScriptCamera Acquires the resource-exclusive GTA script camera and returns a generation token. isScriptCameraLeaseActive Reports whether the calling resource still owns the specified camera generation. setScriptCameraFixed Place the camera at one position and make it look at another, using an immediate cut or GTA's camera transition.

← Back to the SA:O Lua API · How Native script camera works →