Events

Note

---

These events are entirely optional and can be triggered as needed to integrate cd_garage with your own scripts or custom systems.

Client

Client-Side Events

---

• Defined with RegisterNetEvent in client files.
• Triggered using TriggerEvent (if from client) or TriggerClientEvent (if from server).
• Run only on one player's game client (the player's PC).

---

Impound Vehicle

Opens the impound UI. You can send a vehicle's ID as the first argument; otherwise, it will automatically select the closest vehicle.

@parameters

---@param vehicle number | entity The vehicle entity to be impounded.
---@example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
TriggerEvent('cd_garage:ImpoundVehicle', vehicle)

client-side to client-side

TriggerEvent('cd_garage:ImpoundVehicle', vehicle)

server-side to client-side

TriggerClientEvent('cd_garage:ImpoundVehicle', source, vehicle)

---

Impound Vehicle Directly

Impounds a vehicle directly using code without opening the impound UI. Sends detailed data such as the plate, impound location, vehicle properties, and retrieval status.

@parameters

--- @field plate string The vehicle's plate.
--- @field impound number The Impound ID from Config.ImpoundLocations.
--- @field props table The vehicle's properties.
--- @field time number The time the vehicle was impounded.
--- @field description string The reason or description for the impound.
--- @field canretrive boolean Whether the vehicle can be retrieved by the owner.
--- @field vehicle number | entity The vehicle entity.
--- @field custom_fee number|nil Set an impound fee or use nil to calculate it automatically.

client-side to client-side

TriggerEvent('cd_garage:ImpoundVehicle:Direct', {
    plate = plate,
    impound = impound,
    props = props,
    time = time,
    description = description,
    canretrive = canretrive,
    vehicle = vehicle,
    custom_fee = custom_fee
})

server-side to client-side

TriggerClientEvent('cd_garage:ImpoundVehicle:Direct', source, {
    plate = plate,
    impound = impound,
    props = props,
    time = time,
    description = description,
    canretrive = canretrive,
    vehicle = vehicle,
    custom_fee = custom_fee
})

---

Toggle Vehicle Lock

Toggles the lock state of the closest vehicle to the player.

client-side to client-side

TriggerEvent('cd_garage:ToggleVehicleLock')

server-side to client-side

TriggerClientEvent('cd_garage:ToggleVehicleLock', source)

---

Set Vehicle Locked

Locks a vehicle using the garage's built-in key system. You must send the vehicle's ID in the first argument.

@parameters

--- @param vehicle number The vehicle entity to lock.
--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
TriggerEvent('cd_garage:SetVehicleLocked', vehicle)

client-side to client-side

TriggerEvent('cd_garage:SetVehicleLocked', vehicle)

server-side to client-side

TriggerClientEvent('cd_garage:SetVehicleLocked', source, vehicle)

---

Set Vehicle Unlocked

Unlocks a vehicle using the garage's built-in key system. You must send the vehicle's ID in the first argument.

@parameters

--- @param vehicle number The vehicle entity to unlock.
--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
TriggerEvent('cd_garage:SetVehicleUnlocked', vehicle)

client-side to client-side

TriggerEvent('cd_garage:SetVehicleUnlocked', vehicle)

server-side to client-side

TriggerClientEvent('cd_garage:SetVehicleUnlocked', source, vehicle)

Update Garage Type

Updates the vehicle's garage type in the database based on your current vehicle.

client-side to client-side

TriggerEvent('cd_garage:UpdateGarageType')

server-side to client-side

TriggerClientEvent('cd_garage:UpdateGarageType', source)

---

Add Keys

Gives the player keys for a specific vehicle based on its plate.

@parameters

-- @param plate string The vehicle's plate. Example: "ABCD1234"
--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local plate = GetVehicleNumberPlateText(vehicle)
TriggerEvent('cd_garage:AddKeys', plate)

client-side to client-side

TriggerEvent('cd_garage:AddKeys', plate)

server-side to client-side

TriggerClientEvent('cd_garage:AddKeys', source, plate)

---

Remove Keys

Removes the player's keys for a specific vehicle based on its plate.

@parameters

-- @param plate string The vehicle's plate. Example: "ABCD1234"
--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local plate = GetVehicleNumberPlateText(vehicle)
TriggerEvent('cd_garage:RemoveKeys', plate)

client-side to client-side

TriggerEvent('cd_garage:RemoveKeys', plate)

server-side to client-side

TriggerClientEvent('cd_garage:RemoveKeys', source, plate)

---

Show Keys UI

Opens the vehicle keys UI for the player, displaying all vehicles they currently have keys for.

client-side to client-side

TriggerEvent('cd_garage:ShowKeys')

server-side to client-side

TriggerClientEvent('cd_garage:ShowKeys', source)

---

Open Property Garage

Opens an existing property garage or creates one at the player’s current location.

• When the event is triggered, the script checks for a property garage near the player.
• If one is found, that garage will open.
• If one is not found, a new property garage will be created.
• It is recommended to pass the vehicle spawn coordinates in the first argument so the exact spawn location can be used.
• If no coordinates are provided, the player’s current coordinates and heading will be used.

@parameters

--- @param vehicleSpawnCoords? vector4 Optional vehicle spawn coordinates.
--- If not provided, the player's current coordinates and heading will be used.

--- @example
local vehicleSpawnCoords = vector4(0.0, 0.0, 0.0, 0.0) or {x = 0.0, y = 0.0, z = 0.0, h = 0.0}
TriggerEvent('cd_garage:PropertyGarage:Open', vehicleSpawnCoords)

client-side to client-side

TriggerEvent('cd_garage:PropertyGarage:Open', vehicleSpawnCoords)

server-side to client-side

TriggerClientEvent('cd_garage:PropertyGarage:Open', source, vehicleSpawnCoords)

---

Store Vehicle in Property Garage

Stores the player’s current vehicle in the nearby property garage.

client-side to client-side

TriggerEvent('cd_garage:PropertyGarage:StoreVehicle')

server-side to client-side

TriggerClientEvent('cd_garage:PropertyGarage:StoreVehicle', source)

---

Server

Server-Side Events

---

• Defined with RegisterServerEvent and AddEventHandler in server files.
• Triggered using TriggerEvent (if from server) or TriggerServerEvent (if from client).
• Run on the server, not on any individual player's game client.

---

Set Job Owned Vehicle

Marks the vehicle the player is currently sitting in as either a personal or society owned job vehicle.
This event must be triggered while the player is inside the vehicle.

@parameters

--- @param method string The ownership type: 'personal' or 'society'.
--- @param plate string The vehicle plate.
--- @param jobs table Optional. Only used for society owned vehicles to allow extra jobs access.

--- @example For personal owned vehicles:
local method = 'personal'
local plate = 'ABCD1234'

TriggerServerEvent('cd_garage:SetJobOwnedVehicle', method, plate)

--- @example For society owned vehicles:
local method = 'society'
local plate = 'ABCD1234'
local jobs = {
    'police',
    'sheriff'
}

TriggerServerEvent('cd_garage:SetJobOwnedVehicle', method, plate, jobs)

client-side to server-side

TriggerServerEvent('cd_garage:SetJobOwnedVehicle', method, plate)

server-side to server-side

TriggerEvent('cd_garage:SetJobOwnedVehicle', method, plate)

Create Private Garage

Creates a private garage using code. This is mainly useful for property scripts that need to create a garage automatically.

@parameters

--- @param data table The private garage data.
--- @param data.garage_label string The display name of the private garage.
--- @param data.allowed_vehicle_types table The vehicle types allowed in this garage. Example: 'car' 'boat' 'heli' 'plane'. 
--- @param data.coords table The garage location data.
--- @param data.coords.open table The location where players open the garage.
--- @param data.coords.spawn table The location where vehicles spawn.
--- @param data.data table Private garage owner and access data.
--- @param data.data.owner_identifier string Main owner identifier.
--- @param data.data.access_identifiers table Optional list of player identifiers allowed to access the garage.
--- @param data.blip table Optional blip settings.

--- @example
local ped = PlayerPedId()
local coords = GetEntityCoords(ped)
local heading = GetEntityHeading(ped)

local data = {
    garage_label = 'Private Garage',
    allowed_vehicle_types = {'car'},
    coords = {
        open = {
            x = coords.x,
            y = coords.y,
            z = coords.z,
            interact_distance = 5,
            view_distance = 15
        },

        spawn = {
            x = coords.x,
            y = coords.y,
            z = coords.z,
            heading = heading
        }
    },
    data = {
        owner_identifier = 'steam:110000112345678',
        access_identifiers = { -- optional
            'steam:110000112345678',
            'steam:110000112345679'
        }
    },
    blip = { -- optional
        enabled = true,
        sprite = 357,
        scale = 0.6,
        color = 9
    }
}

TriggerServerEvent('cd_garage:PrivateGarage:Create', data)

client-side to server-side

TriggerServerEvent('cd_garage:PrivateGarage:Create', data)

server-side to server-side

TriggerEvent('cd_garage:PrivateGarage:Create', data)

---

Create Property Garage

Creates a property garage using code. This is mainly useful for property scripts that need to create a garage automatically when a property is purchased.

@parameters

--- @param data table The property garage data.
--- @param data.garage_label string The display name of the property garage.
--- @param data.allowed_vehicle_types table The vehicle types allowed in this garage. Example: 'car' 'boat' 'heli' 'plane'.
--- @param data.coords table The garage location data.
--- @param data.coords.open table The location where players open the garage.
--- @param data.coords.spawn table The location where vehicles spawn.
--- @param data.data table Property owner and access data.
--- @param data.data.owner_identifier string Main owner identifier.
--- @param data.data.access_identifiers table Optional list of player identifiers allowed to access the garage.
--- @param data.blip table Optional blip settings.

--- @example
local ped = PlayerPedId()
local coords = GetEntityCoords(ped)
local heading = GetEntityHeading(ped)

local data = {
    garage_label = 'Property Garage',
    allowed_vehicle_types = {'car'},
    coords = {
        open = {
            x = coords.x,
            y = coords.y,
            z = coords.z,
            interact_distance = 5,
            view_distance = 15
        },

        spawn = {
            x = coords.x,
            y = coords.y,
            z = coords.z,
            heading = heading
        }
    },
    data = {
        owner_identifier = 'steam:110000112345678',
        access_identifiers = { -- optional
            'steam:110000112345678',
            'steam:110000112345679'
        }
    },
    blip = { -- optional
        enabled = true,
        sprite = 357,
        scale = 0.6,
        color = 9
    }
}

TriggerServerEvent('cd_garage:PropertyGarage:Create', data)

client-side to server-side

TriggerServerEvent('cd_garage:PropertyGarage:Create', data)

server-side to server-side

TriggerEvent('cd_garage:PropertyGarage:Create', data)

---

Set Garage State

Updates the vehicle's in garage status in the database.

@parameters

--- @param plate string The vehicle's license plate. Example: "ABCD1234"
--- @param state number The vehicle's garage state. 0 = not in garage, 1 = in garage, 2 = in impound.

--- @example
local plate = "ABCD1234"
local state = 1
TriggerEvent('cd_garage:SetGarageState', plate, state)

server-side to server-side

TriggerEvent('cd_garage:SetGarageState', plate, state)

---

Add Owned Keys

Used when adding an owned vehicle to a player's garage. This ensures the new vehicle appears in the player's keys UI.

@parameters

--- @param plate string The vehicle's plate. Example: "ABCD1234"
--- @param model number The vehicle's model hash. Example: 127317925

--- @example
local plate = "ABCD1234"
local model = GetEntityModel(GetVehiclePedIsIn(PlayerPedId()))
TriggerServerEvent('cd_garage:VehicleKeys:AddOwnedKeys', plate, model)

client-side to server-side

TriggerServerEvent('cd_garage:VehicleKeys:AddOwnedKeys', plate, model)

server-side to server-side

TriggerEvent('cd_garage:VehicleKeys:AddOwnedKeys', plate, model, src)

---

Add Persistent Vehicle

Used to mark a vehicle as persistent, allowing it to automatically save and respawn if it despawns while the server is running.

@parameters

--- @param plate string The vehicle's plate. Example: "ABCD1234"
--- @param netId number The vehicle's network ID. Example: NetworkGetNetworkIdFromEntity(vehicle)

--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local plate = GetVehicleNumberPlateText(vehicle)
local netId = NetworkGetNetworkIdFromEntity(vehicle)
TriggerServerEvent('cd_garage:PersistentVehicles:Add', plate, netId)

client-side to server-side

TriggerServerEvent('cd_garage:PersistentVehicles:Add', plate, netId)

server-side to server-side

TriggerEvent('cd_garage:PersistentVehicles:Add', plate, netId)

---

Remove Persistent Vehicle

Used to remove a vehicle from the persistent system, preventing it from saving or respawning automatically.

@parameters

--- @param plate string The vehicle's plate. Example: "ABCD1234"

--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local plate = GetVehicleNumberPlateText(vehicle)
TriggerServerEvent('cd_garage:PersistentVehicles:Remove', plate)

client-side to server-side

TriggerServerEvent('cd_garage:PersistentVehicles:Remove', plate)

server-side to server-side

TriggerEvent('cd_garage:PersistentVehicles:Remove', plate)

---

Persistent Vehicle Plate Changed

When a vehicle's plate is changed while persistent vehicles are enabled, the old plate must be removed from the persistent system. This prevents the vehicle from being saved or respawning using its previous plate.

@parameters

--- @param old_plate string The vehicle's old plate. Example: "ABCD1234"
--- @param new_plate string The vehicle's new plate. Example: "1234ABCD"

--- @example
local old_plate = "ABCD1234"
local new_plate = "1234ABCD"
TriggerServerEvent('cd_garage:PersistentVehicles:PlateChanged', old_plate, new_plate)

client-side to server-side

TriggerServerEvent('cd_garage:PersistentVehicles:PlateChanged', old_plate, new_plate)

server-side to server-side

TriggerEvent('cd_garage:PersistentVehicles:PlateChanged', old_plate, new_plate)

---

Transfer Vehicle

Transfers a vehicle to another players garage.

@parameters

--- @param plate string The plate of the vehicle to transfer.
--- @param serverid number The server ID of the player to transfer the vehicle to.

--- @example
local plate = 'ABCD1234'
local serverId = 23
TriggerServerEvent('cd_garage:TransferVehicle', plate, serverId)

client-side to server-side

TriggerEvent('cd_garage:TransferVehicle', plate, serverid)

server-side to server-side

TriggerEvent('cd_garage:TransferVehicle', plate, serverid)

Save Vehicle Damage Timer

Saves the damage data for all vehicles currently tracked by cd_garage. Typically used before a server restart.

server-side to client-side

TriggerClientEvent('cd_garage:SaveAllVehicleDamage', -1)

---

Save Impound Timer

Saves all active impound timers to the database, ensuring impounded vehicle durations are correctly updated and persistent.

server-side to server-side

TriggerEvent('cd_garage:SaveImpoundTimers')

---

Set Vehicle Hotwired

Marks a vehicle as hotwired so it can be driven by anyone.

@parameters

--- @param netId number The vehicle network ID.
--- @param plate string The vehicle plate.

--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local netId = NetworkGetNetworkIdFromEntity(vehicle)
local plate = GetVehicleNumberPlateText(vehicle)

TriggerServerEvent('cd_garage:VehicleKeys:SetVehicleHotwired', netId, plate)

client-side to server-side

TriggerServerEvent('cd_garage:VehicleKeys:SetVehicleHotwired', netId, plate)

server-side to server-side

TriggerEvent('cd_garage:VehicleKeys:SetVehicleHotwired', netId, plate)

---

Set Vehicle Not Hotwired

Removes the hotwired state from a vehicle.

@parameters

--- @param netId number The vehicle network ID.
--- @param plate string The vehicle plate.

--- @example
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local netId = NetworkGetNetworkIdFromEntity(vehicle)
local plate = GetVehicleNumberPlateText(vehicle)

TriggerServerEvent('cd_garage:VehicleKeys:SetVehicleNotHotwired', netId, plate)

client-side to server-side

TriggerServerEvent('cd_garage:VehicleKeys:SetVehicleNotHotwired', netId, plate)

server-side to server-side

TriggerEvent('cd_garage:VehicleKeys:SetVehicleNotHotwired', netId, plate)