NEON APINative script camera

Available in Neon, not standard MTA

Acquires the resource-exclusive GTA script camera and returns a generation token.

Syntax

Copy signature

int|false acquireScriptCamera([bool inhibitControls = false])

Arguments

inhibitControlsbooloptional · default false

Also engage the reference-counted gameplay inhibitor and native player-safe braking bit.

Returns

A non-zero generation token, or false when another resource owns the lease.

Ownership and lifecycle

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

Example

local token = assert(acquireScriptCamera(true))
assert(setScriptCameraFixed(token, Vector3(0, 0, 20), Vector3(0, 0, 0)))

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 NEON APIS

Continue exploring

Read the system guide →

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. setScriptCameraFixed Activates GTA's fixed script camera and native point-at control.

Next in category →releaseScriptCamera

← Back to the Neon Lua API · How Native script camera works →