Server Side Exports

Vehicle Fuel Management

GetFuel

Gets the fuel level of a vehicle from server side using state bags.

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

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID

Returns:

Type	Description
number	The current fuel level (0-100), or -1 if vehicle not found. Returns 100 if fuel state not set.

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)
local fuel = exports['lyre_fuel']:GetFuel(vehicleNetId)
if fuel >= 0 then
    print("Vehicle fuel: " .. fuel .. "%")
end

---

SetFuel

Sets the fuel level of a vehicle from server side using state bags.

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

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID
fuel	number	The fuel level to set (0-100)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)
local success = exports['lyre_fuel']:SetFuel(vehicleNetId, 50)
if success then
    print("Vehicle fuel set to 50%")
end

---

GetFuelType

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

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

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID

Returns:

Type	Description
string or nil	The fuel type key (e.g., "general", "diesel", "electric"), or nil if vehicle not found

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)
local fuelType = exports['lyre_fuel']:GetFuelType(vehicleNetId)
if fuelType then
    print("Vehicle uses fuel type: " .. fuelType)
end

---

Station Data Retrieval

GetAllStations

Returns all stations data.

local stations = exports['lyre_fuel']:GetAllStations()

Parameters: None

Returns:

Type	Description
table	All stations indexed by station ID

Example:

local stations = exports['lyre_fuel']:GetAllStations()
for stationId, stationData in pairs(stations) do
    print("Station: " .. stationData.name .. " (ID: " .. stationId .. ")")
end

---

GetStationById

Returns a specific station by its ID.

local station = exports['lyre_fuel']:GetStationById(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
table or nil	The station data table, or nil if not found

Returned Table Structure:

{
    id = "station_123",
    name = "Downtown Gas Station",
    owner = "char1:abc123",           -- or nil if no owner
    account = 5000,                   -- Station bank balance
    state = "OPEN",                   -- or "CLOSED"
    sellState = false,                -- Is listed for sale
    sellPrice = 50000,                -- Sale price
    fuelTypes = {
        ["general"] = {
            pricePerUnit = 2.5,
            currentStock = 500,
            maxStock = 1000,
            tankLevel = 0,
            sellItems = true,
            itemPrice = 150,
        },
        -- ... other fuel types
    },
    locations = { ... },              -- Pump, ped, vehicle locations
    config = { ... },                 -- Station configuration
}

Example:

local station = exports['lyre_fuel']:GetStationById("downtown_station")
if station then
    print("Station name: " .. station.name)
    print("Owner: " .. (station.owner or "No owner"))
    print("Account balance: $" .. station.account)
end

---

GetStationsByOwner

Returns all stations owned by a specific player.

local stations = exports['lyre_fuel']:GetStationsByOwner(ownerIdentifier)

Parameters:

Name	Type	Description
ownerIdentifier	string	The owner identifier (e.g., "char1:abc123")

Returns:

Type	Description
table	Array of station data tables owned by the player (empty array if none)

Example:

local playerIdentifier = "char1:abc123"
local ownedStations = exports['lyre_fuel']:GetStationsByOwner(playerIdentifier)
print("Player owns " .. #ownedStations .. " stations")
for _, station in ipairs(ownedStations) do
    print("- " .. station.name)
end

---

GetStationName

Returns the name of a station.

local name = exports['lyre_fuel']:GetStationName(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
string or nil	The station name, or nil if not found

Example:

local name = exports['lyre_fuel']:GetStationName("downtown_station")
if name then
    print("Station name: " .. name)
end

---

GetStationOwner

Returns the owner identifier of a station.

local owner = exports['lyre_fuel']:GetStationOwner(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
string or nil	The owner identifier, or nil if not found or no owner

Example:

local owner = exports['lyre_fuel']:GetStationOwner("downtown_station")
if owner then
    print("Station owner: " .. owner)
else
    print("Station has no owner")
end

---

GetStationState

Returns the state of a station (OPEN or CLOSED).

local state = exports['lyre_fuel']:GetStationState(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
string or nil	The station state ("OPEN" or "CLOSED"), or nil if not found

Example:

local state = exports['lyre_fuel']:GetStationState("downtown_station")
if state == "OPEN" then
    print("Station is open for business")
else
    print("Station is closed")
end

---

GetStationSellState

Returns whether a station is for sale.

local isForSale = exports['lyre_fuel']:GetStationSellState(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
boolean or nil	Whether the station is for sale, or nil if not found

Example:

local isForSale = exports['lyre_fuel']:GetStationSellState("downtown_station")
if isForSale then
    local price = exports['lyre_fuel']:GetStationSellPrice("downtown_station")
    print("Station is for sale at $" .. price)
end

---

GetStationSellPrice

Returns the sell price of a station.

local price = exports['lyre_fuel']:GetStationSellPrice(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
number or nil	The sell price, or nil if not found

Example:

local price = exports['lyre_fuel']:GetStationSellPrice("downtown_station")
if price then
    print("Station sell price: $" .. price)
end

---

GetStationFuelTypes

Returns all fuel types available at a station.

local fuelTypes = exports['lyre_fuel']:GetStationFuelTypes(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
table or nil	The fuel types table, or nil if not found

Returned Table Structure:

{
    ["general"] = {
        pricePerUnit = 2.5,
        currentStock = 500,
        maxStock = 1000,
        tankLevel = 0,
        sellItems = true,
        itemPrice = 150,
    },
    ["diesel"] = { ... },
    -- ... other fuel types enabled at this station
}

Example:

local fuelTypes = exports['lyre_fuel']:GetStationFuelTypes("downtown_station")
if fuelTypes then
    for fuelType, data in pairs(fuelTypes) do
        print(fuelType .. ": $" .. data.pricePerUnit .. "/unit")
    end
end

---

GetFuelPrice

Returns the price per unit of a fuel type at a station.

local price = exports['lyre_fuel']:GetFuelPrice(stationId, fuelType)

Parameters:

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

Returns:

Type	Description
number or nil	The price per unit, or nil if not found

Example:

local price = exports['lyre_fuel']:GetFuelPrice("downtown_station", "general")
if price then
    print("Gasoline price: $" .. price .. "/L")
end

---

GetStationStock

Returns the current stock of a fuel type at a station.

local stock = exports['lyre_fuel']:GetStationStock(stationId, fuelType)

Parameters:

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

Returns:

Type	Description
number or nil	The current stock, or nil if not found

Example:

local stock = exports['lyre_fuel']:GetStationStock("downtown_station", "general")
if stock then
    print("Gasoline stock: " .. stock .. "L")
end

---

Station Account Management

GetStationAccount

Returns the account balance of a station.

local balance = exports['lyre_fuel']:GetStationAccount(stationId)

Parameters:

Name	Type	Description
stationId	string	The station ID

Returns:

Type	Description
number or nil	The station account balance, or nil if not found

Example:

local balance = exports['lyre_fuel']:GetStationAccount("downtown_station")
if balance then
    print("Station balance: $" .. balance)
end

---

SetStationAccount

Sets the account balance of a station.

local success = exports['lyre_fuel']:SetStationAccount(stationId, amount)

Parameters:

Name	Type	Description
stationId	string	The station ID
amount	number	The new account balance (minimum 0)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetStationAccount("downtown_station", 10000)
if success then
    print("Station account set to $10,000")
end

---

AddStationAccount

Adds money to a station account balance.

local success = exports['lyre_fuel']:AddStationAccount(stationId, amount)

Parameters:

Name	Type	Description
stationId	string	The station ID
amount	number	The amount to add (must be positive)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:AddStationAccount("downtown_station", 500)
if success then
    print("Added $500 to station account")
end

---

RemoveStationAccount

Removes money from a station account balance.

local success = exports['lyre_fuel']:RemoveStationAccount(stationId, amount)

Parameters:

Name	Type	Description
stationId	string	The station ID
amount	number	The amount to remove (must be positive, balance won't go below 0)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:RemoveStationAccount("downtown_station", 200)
if success then
    print("Removed $200 from station account")
end

---

Station Stock Management

SetStationStock

Sets the current stock of a fuel type at a station.

local success = exports['lyre_fuel']:SetStationStock(stationId, fuelType, stock)

Parameters:

Name	Type	Description
stationId	string	The station ID
fuelType	string	The fuel type key (e.g., "general", "diesel", "electric")
stock	number	The new stock value (capped at max stock)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetStationStock("downtown_station", "general", 1000)
if success then
    print("Gasoline stock set to 1000L")
end

---

AddStationStock

Adds stock to a fuel type at a station.

local success = exports['lyre_fuel']:AddStationStock(stationId, fuelType, amount)

Parameters:

Name	Type	Description
stationId	string	The station ID
fuelType	string	The fuel type key (e.g., "general", "diesel", "electric")
amount	number	The amount to add (must be positive, capped at max stock)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:AddStationStock("downtown_station", "diesel", 500)
if success then
    print("Added 500L of diesel")
end

---

RemoveStationStock

Removes stock from a fuel type at a station.

local success = exports['lyre_fuel']:RemoveStationStock(stationId, fuelType, amount)

Parameters:

Name	Type	Description
stationId	string	The station ID
fuelType	string	The fuel type key (e.g., "general", "diesel", "electric")
amount	number	The amount to remove (must be positive, stock won't go below 0)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:RemoveStationStock("downtown_station", "electric", 100)
if success then
    print("Removed 100 kWh from stock")
end

---

Station Configuration

SetStationName

Sets the name of a station.

local success = exports['lyre_fuel']:SetStationName(stationId, name)

Parameters:

Name	Type	Description
stationId	string	The station ID
name	string	The new station name (non-empty string)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetStationName("downtown_station", "Premium Gas Station")
if success then
    print("Station renamed")
end

---

SetStationOwner

Sets the owner of a station.

local success = exports['lyre_fuel']:SetStationOwner(stationId, ownerIdentifier)

Parameters:

Name	Type	Description
stationId	string	The station ID
ownerIdentifier	string or nil	The new owner identifier, or nil to remove owner

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

-- Set a new owner
local success = exports['lyre_fuel']:SetStationOwner("downtown_station", "char1:abc123")

-- Remove owner (make public)
local success = exports['lyre_fuel']:SetStationOwner("downtown_station", nil)

---

SetStationState

Sets the state of a station (OPEN or CLOSED).

local success = exports['lyre_fuel']:SetStationState(stationId, state)

Parameters:

Name	Type	Description
stationId	string	The station ID
state	string	The new state ("OPEN" or "CLOSED")

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetStationState("downtown_station", "CLOSED")
if success then
    print("Station is now closed")
end

---

SetStationSellState

Sets whether a station is for sale.

local success = exports['lyre_fuel']:SetStationSellState(stationId, sellState, sellPrice)

Parameters:

Name	Type	Description
stationId	string	The station ID
sellState	boolean	Whether the station should be for sale
sellPrice	number or nil	The sell price (optional, uses current price if not provided)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

-- Put station for sale at $75,000
local success = exports['lyre_fuel']:SetStationSellState("downtown_station", true, 75000)

-- Remove from sale
local success = exports['lyre_fuel']:SetStationSellState("downtown_station", false)

---

SetStationSellPrice

Sets the sell price of a station.

local success = exports['lyre_fuel']:SetStationSellPrice(stationId, price)

Parameters:

Name	Type	Description
stationId	string	The station ID
price	number	The new sell price (minimum 0)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetStationSellPrice("downtown_station", 100000)
if success then
    print("Station sale price set to $100,000")
end

---

SetFuelPrice

Sets the price per unit of a fuel type at a station.

local success = exports['lyre_fuel']:SetFuelPrice(stationId, fuelType, price)

Parameters:

Name	Type	Description
stationId	string	The station ID
fuelType	string	The fuel type key (e.g., "general", "diesel", "electric")
price	number	The new price per unit (minimum 0)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local success = exports['lyre_fuel']:SetFuelPrice("downtown_station", "general", 3.50)
if success then
    print("Gasoline price set to $3.50/L")
end

---

Vehicle Blacklist Management

AddVehicleToBlacklist

Temporarily adds a specific vehicle to the refuel blacklist.

local success = exports['lyre_fuel']:AddVehicleToBlacklist(vehicleNetId, duration)

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID
duration	number or nil	Duration in seconds (nil or -1 for permanent until restart)

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)

-- Blacklist for 5 minutes
local success = exports['lyre_fuel']:AddVehicleToBlacklist(vehicleNetId, 300)

-- Blacklist permanently until server restart
local success = exports['lyre_fuel']:AddVehicleToBlacklist(vehicleNetId, nil)

---

RemoveVehicleFromBlacklist

Removes a specific vehicle from the temporary refuel blacklist.

local success = exports['lyre_fuel']:RemoveVehicleFromBlacklist(vehicleNetId)

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID

Returns:

Type	Description
boolean	Whether the operation was successful

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)
local success = exports['lyre_fuel']:RemoveVehicleFromBlacklist(vehicleNetId)
if success then
    print("Vehicle removed from blacklist")
end

---

IsVehicleBlacklisted

Checks if a specific vehicle is in the temporary blacklist.

local isBlacklisted = exports['lyre_fuel']:IsVehicleBlacklisted(vehicleNetId)

Parameters:

Name	Type	Description
vehicleNetId	number	The vehicle network ID

Returns:

Type	Description
boolean	Whether the vehicle is blacklisted

Example:

local vehicleNetId = NetworkGetNetworkIdFromEntity(vehicle)
if exports['lyre_fuel']:IsVehicleBlacklisted(vehicleNetId) then
    print("This vehicle is temporarily blacklisted")
end

---

Utility Functions

GetScriptConfiguration

Returns the full script configuration.

local config = exports['lyre_fuel']:GetScriptConfiguration()

Parameters: None

Returns:

Type	Description
table	The script configuration table (Config)

Example:

local config = exports['lyre_fuel']:GetScriptConfiguration()
print("Pump radius: " .. config.pumpRadius)
print("Default buy price: $" .. config.defaultStationSettings.defaultBuyPrice)

---

RefreshAllClients

Forces all clients to refresh their station data.

exports['lyre_fuel']:RefreshAllClients()

Parameters: None

Returns: None (void)

Example:

-- After making changes to stations via exports
exports['lyre_fuel']:RefreshAllClients()
print("All clients refreshed")

---

Quick Reference

Getters

Export	Parameters	Returns	Description
GetFuel	vehicleNetId	number	Get vehicle fuel level
GetFuelType	vehicleNetId	string/nil	Get vehicle fuel type
GetAllStations	-	table	Get all stations
GetStationById	stationId	table/nil	Get station by ID
GetStationsByOwner	ownerIdentifier	table	Get stations by owner
GetStationName	stationId	string/nil	Get station name
GetStationOwner	stationId	string/nil	Get station owner
GetStationState	stationId	string/nil	Get station state
GetStationSellState	stationId	boolean/nil	Get if station is for sale
GetStationSellPrice	stationId	number/nil	Get station sell price
GetStationAccount	stationId	number/nil	Get station balance
GetStationFuelTypes	stationId	table/nil	Get station fuel types
GetFuelPrice	stationId, fuelType	number/nil	Get fuel price at station
GetStationStock	stationId, fuelType	number/nil	Get fuel stock at station
GetScriptConfiguration	-	table	Get script config
IsVehicleBlacklisted	vehicleNetId	boolean	Check if vehicle is blacklisted

Setters

Export	Parameters	Returns	Description
SetFuel	vehicleNetId, fuel	boolean	Set vehicle fuel level
SetStationName	stationId, name	boolean	Set station name
SetStationOwner	stationId, ownerIdentifier	boolean	Set station owner
SetStationState	stationId, state	boolean	Set station state
SetStationSellState	stationId, sellState, sellPrice?	boolean	Set if station is for sale
SetStationSellPrice	stationId, price	boolean	Set station sell price
SetStationAccount	stationId, amount	boolean	Set station balance
SetStationStock	stationId, fuelType, stock	boolean	Set fuel stock
SetFuelPrice	stationId, fuelType, price	boolean	Set fuel price

Modifiers

Export	Parameters	Returns	Description
AddStationAccount	stationId, amount	boolean	Add to station balance
RemoveStationAccount	stationId, amount	boolean	Remove from station balance
AddStationStock	stationId, fuelType, amount	boolean	Add fuel stock
RemoveStationStock	stationId, fuelType, amount	boolean	Remove fuel stock
AddVehicleToBlacklist	vehicleNetId, duration?	boolean	Blacklist a vehicle
RemoveVehicleFromBlacklist	vehicleNetId	boolean	Remove from blacklist

Utility

Export	Parameters	Returns	Description
RefreshAllClients	-	void	Force refresh all clients