Exports

All five exports are client-side. Call them from your own client scripts to drive playback - intro scenes, cinematic tools, staff events.

-- Play a cutscene by name
exports['dzr-cutscenes']:PlayCutscene('family_1_int')

-- Stop the current cutscene
exports['dzr-cutscenes']:StopCutscene()

-- Is a cutscene playing right now?
local active = exports['dzr-cutscenes']:IsCutsceneActive()

-- Name of the current cutscene (or nil)
local name = exports['dzr-cutscenes']:GetCurrentCutscene()

-- The full list of catalogued cutscene names
local list = exports['dzr-cutscenes']:GetCutsceneList()

Behavior notes

• PlayCutscene runs the same pipeline as the browser: screen fade (Config.UseFades), outfit snapshot, timecycle and LOD handling, and the stop keys stay active - so a scene you trigger programmatically can still be stopped by the player.
• Playback respects the same load and start timeouts as the browser (Config.CutsceneLoadTimeout, Config.CutsceneStartTimeout), so a bad identifier fails cleanly instead of hanging the screen.
• Appearance preservation is best-effort per cutscene (the actor handle is defined per .cut file) - the player's own outfit is always restored after the scene ends.

Tip

Combine GetCutsceneList with your own filtering to build themed pickers (for example, only mp_ prefixed scenes) on top of this resource instead of maintaining your own catalog.