Exports

This page documents the available exports for interacting with the kartik-mechanic system from other scripts.

---

Client-Side Exports

GetMileage

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)

ToggleHUD

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)

OpenTuningTablet

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

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

---

Server-Side Exports

GetVehicleMileage

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)

SetVehicleMileage

Updates the mileage for a specific vehicle plate.

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

GetVehiclePartsWear

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)

SetVehiclePartsWear

Updates wear levels for vehicle parts.

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

GetVehicleLastPartsChange

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)

LogTransaction

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

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

GetShopData

Retrieves configuration and balance data for a specific mechanic shop.

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