Skip to content
San Andreas Online Docs

fadeScriptCamera

Client-side
SA:O APINative script camera

Runs GTA's native fade under the current camera lease.

Syntax

bool fadeScriptCamera(int token, bool fadeIn, float durationSeconds [, int red = 0, int green = 0, int blue = 0])

Arguments

tokenint

Current lease token.

fadeInbool

true to reveal, false to fade to color.

durationSecondsfloat

Non-negative fade duration.

red, green, blueintoptional · default 0, 0, 0

Fade color channels from 0 through 255.

Returns

true when the native fade was accepted; false otherwise.

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 →