Client Exports

getMileage

Returns the mileage, in kilometers, of the current you are currently in. Will return false if the entity does not exist.

---@return number|false mileageKm
exports["jg-vehiclemileage"]:getMileage()

getMileageByEntity

Returns the mileage, in kilometers, of a specified entity. Will return false if the entity does not exist.

---@param vehicle integer
---@return number|false mileageKm
exports["jg-vehiclemileage"]:getMileageByEntity(vehicle)

getMileageByPlate

Returns the mileage, in kilometers, of a specified vehicle plate. Will return false if the plate could not be found in the database.

This export makes a database call, so use sparingly.

---@param plate string
---@return number|false mileageKm
exports["jg-vehiclemileage"]:getMileageByPlate(plate)

getUnit

Returns the config option of either kilometers or miles set in the jg-vehiclemileage config.

---@return "miles"|"kilometers"
exports["jg-vehiclemileage"]:getUnit()