SA:O APINative file cutscenes

Applies GTA's native skip path to the owned playback.

Syntax

Copy signature

bool skipFileCutscene(int token)

Arguments

tokenint

Current started file-cutscene token.

Returns

true when GTA accepted and recorded the skip; false before start or for invalid ownership.

Ownership and lifecycle

File cutscenes share GTA's exclusive camera lease. Release, resource shutdown, disconnect, or a camera takeover deletes the native cutscene before restoring gameplay state.

Important behavior

• This function is local. Cooperative resources should call it only after the server authorizes and broadcasts the skip.

Where this comes from

SOURCECLuaCameraDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaCameraDefs.cpp INTRODUCED / EXTENDED4f2be00c1Read the commit and why the change was made TEST RESOURCE tagging-up-turf test-resources/tagging-up-turf

RELATED SA:O APIS

Continue exploring

Read the system guide →

requestFileCutscene Load one of GTA:SA's original mission cutscenes by name. The returned handle lets Lua start it, detect completion, skip it, and restore gameplay afterward. isFileCutsceneLeaseActive Reports whether the calling resource still owns this file-cutscene generation. isFileCutsceneLoaded Reports whether GTA has finished loading the owned DAT/CUT/IFP cutscene data.

← Previous in categorywasFileCutsceneSkipped Next in category →releaseFileCutscene

← Back to the SA:O Lua API · How Native file cutscenes works →