Server Events
Vehicles:Server:PlayerSetProperties
Triggered when client sends vehicle properties after first spawn. Parameters:
Example:
- Automatically triggered by framework when vehicle spawns without saved properties
- Do not trigger manually unless creating custom vehicle spawning logic
Vehicles:Server:StopDespawn
Prevent a temporary vehicle from despawning. Parameters:
Example:
Vehicles:Server:FlipVehicle
Request to flip an overturned vehicle. Parameters:
Example:
Vehicles:Server:StealLocalKeys
Give player keys to a vehicle (lockpicking, etc.). Parameters:
Example:
Vehicles:Server:HarnessDamage
Apply damage to racing harness. Example:Vehicles:Server:RemoveBomb
Remove car bomb from vehicle. Parameters:
Example:
Client Events
Vehicles:Client:UpdateKeys
Update client’s vehicle keys table. Parameters:
Example:
- Player receives keys
- Player loses keys
- Character spawns/selects character
Vehicles:Client:ViewVIN
Display vehicle VIN to player. Parameters:
Example:
Vehicles:Client:Actions:SwitchSeat
Force player to switch vehicle seat. Parameters:
Example:
Vehicles:Client:Actions:ToggleDoor
Open or close vehicle door. Parameters:
Example:
Vehicles:Client:Actions:ToggleWindow
Open or close vehicle window. Parameters:
Example:
Vehicles:Client:CleaningKit
Trigger vehicle cleaning animation. Example:Vehicles:Client:ToggleAnchor
Toggle boat anchor. Parameters:
Example:
Vehicles:Client:SyncNitroEffect
Sync nitrous visual effects. Parameters:
Example:
Vehicles:Client:SyncPurgeEffect
Sync nitrous purge visual effects. Parameters:
Example:
VehicleSync Events
VehicleSync:Client:OpenDoor
Open vehicle door with sync. Parameters:
Example:
VehicleSync:Client:ShutDoor
Close vehicle door with sync. Parameters:
Example:
VehicleSync:Client:SyncIndicators
Sync turn signal indicators. Parameters:
Example:
VehicleSync:Client:SyncNeons
Sync neon lights state. Parameters:
Example:
VehicleSync:Client:Emergency
Sync emergency vehicle lights and siren. Parameters:
Example:
VehicleSync:Client:EmergencyAirhorn
Sync emergency vehicle airhorn. Parameters:VehicleSync:Client:BodyRepair
Trigger vehicle body repair animation. Parameters:
Example:
Local Client Events
These events are triggered locally on the client for vehicle state management.Vehicles:Client:EnterVehicle
Triggered when player enters a vehicle. Parameters:
Example:
Vehicles:Client:ExitVehicle
Triggered when player exits a vehicle. Parameters:
Example:
Vehicles:Client:BecameDriver
Triggered when player becomes the driver. Parameters:
Example:
Vehicles:Client:SwitchVehicleSeat
Triggered when player switches seats. Parameters:
Example:
Vehicles:Client:Ignition
Triggered when vehicle ignition state changes. Parameters:
Example:
Vehicles:Client:Seatbelt
Triggered when seatbelt state changes. Parameters:
Example:
Vehicles:Client:Cruise
Triggered when cruise control state changes. Parameters:
Example:
Callbacks
Vehicles:GetKeys
Give player keys to a vehicle. Parameters:
Returns:
Example:
Vehicles:ToggleLocks
Toggle vehicle lock state. Parameters:
Returns:
Example:
Vehicles:BreakOpenLock
Force unlock a vehicle (lockpick, etc.). Parameters:
Returns:
Example:
Vehicles:GetVehiclesInStorage
Get vehicles stored in a garage. Parameters:
Returns:
Example:
Vehicles:GetVehiclesInPropertyStorage
Get vehicles stored in property garage. Parameters:
Returns:
Example:
Vehicles:RetrieveVehicleFromStorage
Spawn vehicle from garage/property. Parameters:
Returns:
Example:
Vehicles:PutVehicleInStorage
Store vehicle in garage. Parameters:
Returns:
Example:
Custom Integration Examples
Vehicle Rental System
Job Vehicle Spawn
Vehicle Damage Notification
Next Steps
Vehicles - Exports
Vehicle management methods
Vehicles - Configuration
Vehicle data structures and config
Vehicle Features
Complete vehicle system guide
Keys System
Vehicle keys and access control