Exports

For detailed information on how impacts affect part wear, see the Damage System documentation.

Client-Side ExportsCopy Anchor Link

GetMileageCopy Anchor Link

Returns the current accumulated mileage of the player's vehicle in the current unit (Miles or KM).

local mileage = exports['kartik-mechanic']:GetMileage()
print("Current Mileage: " .. mileage)

ToggleHUDCopy Anchor Link

Toggles the visibility of the mechanic HUD elements (Mileage, Gears, Nitro).

-- Hide HUD
exports['kartik-mechanic']:ToggleHUD(false)

-- Show HUD
exports['kartik-mechanic']:ToggleHUD(true)

OpenTuningTabletCopy Anchor Link

Opens the Tuning Chip interface for the current vehicle (requires a Tuning Chip to be installed).

exports['kartik-mechanic']:OpenTuningTablet()

getNitrousLevelCopy Anchor Link

Returns the current nitrous level (count) for a vehicle.

local level = exports['kartik-mechanic']:getNitrousLevel(vehicle)

refillNitrousCopy Anchor Link

Refills the nitrous for a vehicle. If amount is provided, it adds that amount to the current count (capped at max). If amount is omitted, it refills to 100%.

-- Refill to 100%
exports['kartik-mechanic']:refillNitrous(vehicle)

-- Add 50 units
exports['kartik-mechanic']:refillNitrous(vehicle, 50)

OpenAdminCustomsCopy Anchor Link

Opens the admin customs customization interface for the player's current vehicle. This menu bypasses job restrictions and upgrades are completely free.

exports['kartik-mechanic']:OpenAdminCustoms()

OpenCustomsCopy Anchor Link

General wrapper to open the customs menu with custom configurations.

exports['kartik-mechanic']:OpenCustoms(shopId, extrasOnly, isAdmin)

• shopId (string/nil): Shop configuration ID to use.
• extrasOnly (boolean): If true, only opens liveries/extras.
• isAdmin (boolean): If true, all upgrades are free and job checks are bypassed.

ToggleSeatbeltCopy Anchor Link

Buckles or unbuckles the player's seatbelt (or harness, if one is fitted). Use this instead of the built-in keybind when another resource already owns the seatbelt key, set Config.EnableRegisterKeyMapping = false and call this from your own binding.

exports['kartik-mechanic']:ToggleSeatbelt()

IsSeatbeltOnCopy Anchor Link

Returns true if the player currently has their seatbelt buckled.

if exports['kartik-mechanic']:IsSeatbeltOn() then
    print("Buckled up")
end

HasHarnessCopy Anchor Link

Returns true if the vehicle the player is in has a racing harness installed.

local harness = exports['kartik-mechanic']:HasHarness()

IsVehicleIgnoredCopy Anchor Link

Returns true if the vehicle has been exempted from wear, damage and mileage (see the server-side SetVehicleIgnored).

if exports['kartik-mechanic']:IsVehicleIgnored(vehicle) then
    print("Vehicle is ignored by the mechanic system")
end

Server-Side ExportsCopy Anchor Link

GetVehicleMileageCopy Anchor Link

Retrieves the mileage for a specific vehicle plate. Use a callback to receive the value.

exports['kartik-mechanic']:GetVehicleMileage('ABC 123', function(mileage)
    print("Vehicle Mileage: " .. mileage)
end)

SetVehicleMileageCopy Anchor Link

Updates the mileage for a specific vehicle plate.

exports['kartik-mechanic']:SetVehicleMileage('ABC 123', 5000.0)

GetVehiclePartsWearCopy Anchor Link

Retrieves current wear levels (0.0 to 1.0) for vehicle parts.

exports['kartik-mechanic']:GetVehiclePartsWear('ABC 123', function(wearData)
    if wearData then
        print("Brake Wear: " .. wearData.brakeWear)
        print("Clutch Wear: " .. wearData.clutchWear)
    end
end)

SetVehiclePartsWearCopy Anchor Link

Updates wear levels for vehicle parts.

exports['kartik-mechanic']:SetVehiclePartsWear('ABC 123', {
    brakeWear = 0.1,
    clutchWear = 0.5
})

GetVehicleLastPartsChangeCopy Anchor Link

Retrieves the mileage at which parts were last replaced.

exports['kartik-mechanic']:GetVehicleLastPartsChange('ABC 123', function(history)
    if history then
        print("Last Oil Change: " .. history.oilChange)
    end
end)

LogTransactionCopy Anchor Link

Logs a shop transaction to the database for the management history.

exports['kartik-mechanic']:LogTransaction(shopId, customerId, employeeId, cost, {
    label = "Engine Repair",
    type = "repair"
})

GetShopDataCopy Anchor Link

Retrieves configuration and balance data for a specific mechanic shop.

local shopData = exports['kartik-mechanic']:GetShopData('bennys')

RefillNitrousCopy Anchor Link

Server-side export to refill nitrous for a vehicle by its network ID.

-- Refill to 100%
exports['kartik-mechanic']:RefillNitrous(netId)

-- Add 50 units
exports['kartik-mechanic']:RefillNitrous(netId, 50)

SetVehicleIgnoredCopy Anchor Link

Exempts a single vehicle from wear, crash damage and mileage. Useful for derbies, races, events and rentals where you don't want to whitelist the whole model. The flag only affects that vehicle, syncs to all players and clears automatically when the vehicle is deleted.

-- Ignore the vehicle
exports['kartik-mechanic']:SetVehicleIgnored(netIdOrEntity, true)

-- Stop ignoring the vehicle
exports['kartik-mechanic']:SetVehicleIgnored(netIdOrEntity, false)

• netIdOrEntity (number): Network ID or server entity handle of the vehicle.
• Returns (boolean): true if the vehicle was found and updated.

IsVehicleIgnoredCopy Anchor Link

Returns true if the vehicle is currently ignored.

local ignored = exports['kartik-mechanic']:IsVehicleIgnored(netIdOrEntity)