Skip to content
San Andreas Online Docs

setVehiclePlaybackSpeed

Client-side
SA:O APINative vehicle recordings

Speed up, slow down, or pause a vehicle while it follows its active GTA recorded route.

Syntax

bool setVehiclePlaybackSpeed(vehicle theVehicle, float speed)

GTA task mapping

NATIVE GTA BEHAVIOR 06FD
No CTask is created

SCM equivalent: SET_PLAYBACK_SPEED

GTA changes the speed of the active recorded-car slot; San Andreas Online requires both the playback lease and current vehicle authority.

Arguments

theVehiclevehicle

Streamed vehicle whose active playback belongs to the calling resource.

speedfloat

Playback multiplier from 0 through 16; 1 is normal speed and 0 pauses movement.

Returns

true when the active native playback accepted the speed; false for invalid input, inactive or foreign playback, or a vehicle not controlled by this client.

Ownership and lifecycle

Playback stops when the resource shuts down, the native vehicle is destroyed or streamed out, or sync ownership is lost. It uses opcode 05EB directly and does not loop.

Important behavior
  • The calling resource must own the active playback slot. Stream-out, ownership loss, vehicle destruction, or resource shutdown still stops playback.

Example

assert(startVehiclePlayback(vehicle, recordingId))
assert(setVehiclePlaybackSpeed(vehicle, 2.0)) -- follow the same route at 2x speed

Where this comes from

SOURCECLuaVehicleDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaVehicleDefs.cpp INTRODUCED / EXTENDEDc21792236Read the commit and why the change was made TEST RESOURCE native-vehicle-recording-test test-resources/native-vehicle-recording-test
RELATED SA:O APIS

Continue exploring

Read the system guide →
requestVehicleRecording Acquires and requests one registered GTA carrec recording for the calling resource. isVehicleRecordingLoaded Reports whether a registered recording currently has a streamed native frame buffer. startVehiclePlayback Starts direct non-looped GTA recorded-car playback on a vehicle owned by the local unoccupied-vehicle syncer.

← Back to the SA:O Lua API · How Native vehicle recordings works →