Client Side Exports

Fuel Management

GetFuel

Gets the current fuel level of a vehicle.

local fuel = exports['lyre_fuel']:GetFuel(vehicle)

Parameters:

Name	Type	Description
vehicle	number	The vehicle entity handle

Returns:

Type	Description
number	The current fuel level (0-100)

Example:

local playerVehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local currentFuel = exports['lyre_fuel']:GetFuel(playerVehicle)
print("Current fuel: " .. currentFuel .. "%")

---

SetFuel

Sets the fuel level of a vehicle.

local success = exports['lyre_fuel']:SetFuel(vehicle, fuel)

Parameters:

Name	Type	Description
vehicle	number	The vehicle entity handle
fuel	number	The fuel level to set (0-100)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local playerVehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local success = exports['lyre_fuel']:SetFuel(playerVehicle, 100)
if success then
    print("Vehicle fuel set to 100%")
end

---

Fuel Type Detection

GetFuelType

Gets the fuel type key of a vehicle based on its model.

local fuelType = exports['lyre_fuel']:GetFuelType(vehicle)

Parameters:

Name	Type	Description
vehicle	number	The vehicle entity handle

Returns:

Type	Description
string or nil	The fuel type key (e.g., "general", "diesel", "electric", "boats", "aviation"), or nil if blacklisted

Example:

local playerVehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local fuelType = exports['lyre_fuel']:GetFuelType(playerVehicle)
if fuelType then
    print("This vehicle uses: " .. fuelType)
end

---

GetFuelTypeConfig

Gets the full configuration table for a specific fuel type.

local config = exports['lyre_fuel']:GetFuelTypeConfig(fuelType)

Parameters:

Name	Type	Description
fuelType	string	The fuel type key (e.g., "general", "diesel", "electric")

Returns:

Type	Description
table or nil	The fuel type configuration table, or nil if not found

Returned Table Structure:

{
    label = "Gasoline",                    -- Display name
    unit = { letter = "L", name = "liter" }, -- Unit configuration
    icon = "fa-solid fa-gas-pump",         -- FontAwesome icon
    color = "#4CAF50",                     -- Hex color for UI
    isLiquid = true,                       -- Whether this is a liquid fuel
    supplierPrice = 1.5,                   -- Supplier price per unit
    timeToRefuel = 250,                    -- Time in ms to refuel one unit
    expressFeesPercentage = 20,            -- Express refill fee percentage
    blip = { ... },                        -- Blip configuration
    refillVisual = { ... },                -- Visual effects during refueling
    sounds = { ... },                      -- Sound effects
    usageAmount = { ... },                 -- Consumption rates by RPM
    vehicles = { ... },                    -- List of vehicle models
}

Example:

local dieselConfig = exports['lyre_fuel']:GetFuelTypeConfig("diesel")
if dieselConfig then
    print("Diesel label: " .. dieselConfig.label)
    print("Supplier price: $" .. dieselConfig.supplierPrice .. "/L")
end

---

GetVehicleFuelTypeConfig

Gets the full fuel type configuration for a specific vehicle.

local config = exports['lyre_fuel']:GetVehicleFuelTypeConfig(vehicle)

Parameters:

Name	Type	Description
vehicle	number	The vehicle entity handle

Returns:

Type	Description
table or nil	The fuel type configuration table, or nil if blacklisted

Example:

local playerVehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local fuelConfig = exports['lyre_fuel']:GetVehicleFuelTypeConfig(playerVehicle)
if fuelConfig then
    print("Vehicle uses: " .. fuelConfig.label)
    print("Unit: " .. fuelConfig.unit.name)
end

---

Quick Reference

Export	Parameters	Returns	Description
GetFuel	vehicle	number	Gets vehicle fuel level (0-100)
SetFuel	vehicle, fuel	boolean	Sets vehicle fuel level
GetFuelType	vehicle	string/nil	Gets fuel type key for vehicle
GetFuelTypeConfig	fuelType	table/nil	Gets fuel type configuration
GetVehicleFuelTypeConfig	vehicle	table/nil	Gets fuel config for vehicle
IsVehicleBlacklisted	vehicle	boolean	Checks if vehicle is blacklisted