Skip to content
San Andreas Online Docs

setScriptCameraWidescreen

Client-side
SA:O APINative script camera

Uses GTA's native widescreen transition under the current lease.

Syntax

bool setScriptCameraWidescreen(int token, bool enabled)

Arguments

tokenint

Current lease token.

enabledbool

Desired widescreen state.

Returns

true when applied; false for a stale or foreign lease.

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. releaseScriptCamera Restores captured gameplay camera state and optionally leaves a successful scene under its black fade. isScriptCameraLeaseActive Reports whether the calling resource still owns the specified camera generation.

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