Commands and Exports

Commands#

This section lists all available commands included in the script. Each command is designed to simplify administration, player interaction, or debugging tasks. You’ll find detailed descriptions, usage examples, and permission requirements to help you manage and customize your server efficiently.

Command	Description
`/usekey`	Locks or unlocks the nearest vehicle that the player owns keys for.
`/hotwire`	Attempts to hotwire the vehicle the player is currently inside when no valid keys are available.
`/stealnpckey`

Commands and Exports | Quasar Store

GiveKeys

Gives vehicle keys to the player for a specific vehicle. This export is commonly used after purchasing a vehicle, spawning a vehicle from a garage, or rewarding ownership through custom scripts. The vehicle plate and model must match the target vehicle.

lua

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local model = GetDisplayNameFromVehicleModel(GetEntityModel(veh))
    local plate = GetVehicleNumberPlateText(veh)

    exports['qs-vehiclekeys']:GiveKeys(plate, model, false)
end

RemoveKeys

Removes ownership keys from the player for a specific vehicle. This can be useful when selling vehicles, confiscating them, or removing access through custom systems.

javascript

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local model = GetDisplayNameFromVehicleModel(GetEntityModel(veh))
    local plate = GetVehicleNumberPlateText(veh)

    exports['qs-vehiclekeys']:RemoveKeys(plate, model)
end

GetKey

Checks whether the player currently owns the keys for a vehicle. This export is useful for restricting interactions such as engine controls, trunk access, or custom vehicle systems.

lua

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local model = GetDisplayNameFromVehicleModel(GetEntityModel(veh))
    local plate = GetVehicleNumberPlateText(veh)

    local hasKey = exports['qs-vehiclekeys']:GetKey(plate, model)

    print('Has keys:', hasKey)
end

GiveKeysAuto

Automatically grants keys for the vehicle the player is currently driving or occupying. This is useful when you already have a vehicle reference and want to avoid manually providing the plate and model.

lua

exports['qs-vehiclekeys']:GiveKeysAuto()

CanUseVehicle

Determines whether the player is allowed to use a vehicle. This includes vehicles that have valid keys as well as vehicles successfully started through the hotwire system.

lua

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local canUse = exports['qs-vehiclekeys']:CanUseVehicle(veh)

    print('Can use vehicle:', canUse)
end

RequestKeyTransfer

Creates a key transfer request to another player. If accepted, the target player will receive ownership keys for the selected vehicle.

javascript

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local model = GetDisplayNameFromVehicleModel(GetEntityModel(veh))
    local plate = GetVehicleNumberPlateText(veh)

    exports['qs-vehiclekeys']:RequestKeyTransfer({
        targetId = 5,
        plate = plate,
        model = model
    })
end

OpenCar

Unlocks a vehicle instantly. This export can be used by jobs, garage systems, remote controls, or custom interactions.

lua

local veh = GetClosestVehicle(GetEntityCoords(PlayerPedId()), 5.0, 0, 71)

if veh ~= 0 then
    exports['qs-vehiclekeys']:OpenCar(veh)
end

CloseCar

Locks a vehicle instantly. This is useful for custom key systems, commands, or job-related vehicle management.

lua

local veh = GetClosestVehicle(GetEntityCoords(PlayerPedId()), 5.0, 0, 71)

if veh ~= 0 then
    exports['qs-vehiclekeys']:CloseCar(veh)
end

disableHotwire

Allows you to completely disable or re-enable the hotwire system. This is useful during missions, tutorials, special events, or custom gameplay situations where vehicle theft should be restricted.

lua

-- Disable hotwire
exports['qs-vehiclekeys']:disableHotwire(true)

-- Enable hotwire again
exports['qs-vehiclekeys']:disableHotwire(false)

DoorLogic

Handles the complete vehicle locking system, including lock states, sounds, lights, notifications, and animations. It is the main export used internally when locking or unlocking vehicles.

lua

local veh = GetClosestVehicle(GetEntityCoords(PlayerPedId()), 5.0, 0, 71)

if veh ~= 0 then
    exports['qs-vehiclekeys']:DoorLogic(veh)
end

GetDoorState

Returns the current lock state of a vehicle. This can be used by custom UIs or scripts that need to display vehicle access information.

lua

local veh = GetClosestVehicle(GetEntityCoords(PlayerPedId()), 5.0, 0, 71)

if veh ~= 0 then
    local state = exports['qs-vehiclekeys']:GetDoorState(veh)

    print('Door state:', state)
end

toggleEngine

Allows you to start or stop a vehicle engine. You can either toggle the current state or force the engine to a specific state.

lua

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    exports['qs-vehiclekeys']:toggleEngine(true, veh)
end

isEngineRunning

Checks whether a vehicle engine is currently running. Useful for custom HUDs, dashboards, or gameplay systems.

javascript

local veh = GetVehiclePedIsIn(PlayerPedId(), false)

if veh ~= 0 then
    local running = exports['qs-vehiclekeys']:isEngineRunning(veh)

    print('Engine running:', running)
end

UseLockpick

Starts the lockpick minigame on the nearest vehicle. This export supports both standard and advanced lockpicks depending on the provided parameter.

lua

-- Standard lockpick
exports['qs-vehiclekeys']:UseLockpick(false)

-- Advanced lockpick
exports['qs-vehiclekeys']:UseLockpick(true)

GetPlateFormat

Returns the current license plate configuration, including letter count, number count, and spacing settings.

lua

local format = exports['qs-vehiclekeys']:GetPlateFormat()

print(json.encode(format, { indent = true }))

ToggleBoatAnchor

Toggles the anchor state of the boat the player is currently operating. When anchored, the boat will remain stationary on the water.

lua

local success = exports['qs-vehiclekeys']:ToggleBoatAnchor()

print('Anchor changed:', success)

GiveServerKeys

Gives vehicle keys to a specific player directly from the server. This export is recommended for garages, dealerships, impounds, and any ownership-related systems.

lua

exports['qs-vehiclekeys']:GiveServerKeys(source, plate, model, false)

RemoveServerKeys

Removes vehicle keys from a specific player through the server. This is commonly used when a vehicle is sold, deleted, or confiscated.

lua

exports['qs-vehiclekeys']:RemoveServerKeys(source, plate, model)

GetServerKey

Checks whether a specific player owns the keys for a vehicle. This export is useful when validating ownership before performing server-side actions.

javascript

local hasKey = exports['qs-vehiclekeys']:GetServerKey(source, plate, model)

print(hasKey)

Commands#

Commands and Exports

Commands and Exports

Commands#

Client Exports#

Server Exports#