Exports

Open Finance List

Opens the finance management interface for the player.

Syntax

exports['uz_Dealerships']:openFinanceList()

Usage Example

-- Open finance list when player uses a command
RegisterCommand('myfinances', function()
    exports['uz_Dealerships']:openFinanceList()
end, false)

-- Open finance list from another resource
TriggerEvent('some:event', function()
    exports['uz_Dealerships']:openFinanceList()
end)

Description Displays all active financing contracts for the player, including payment history and outstanding balances.

Player must have at least one active financing contract to view data.

---

Open Showroom

Opens a specific dealership showroom interface.

Syntax

exports['uz_Dealerships']:openShowroom(dealershipID)

Parameters

• dealershipID (number) - The unique identifier of the dealership

Usage Example

-- Open dealership #1 showroom
exports['uz_Dealerships']:openShowroom(1)

-- Open showroom from interaction point
RegisterNetEvent('dealership:enterShowroom', function(id)
    exports['uz_Dealerships']:openShowroom(id)
end)

-- Open specific dealership via command
RegisterCommand('luxurycars', function()
    exports['uz_Dealerships']:openShowroom(3) -- Opens dealership ID 3
end, false)

Description Launches the vehicle browsing interface for the specified dealership location.

Invalid dealership IDs will result in no action. Verify dealership configuration before use.

---

Get Vehicle Data

Retrieves complete data for a specific vehicle model.

Syntax

exports['uz_Dealerships']:GetVehicleData(model)

Parameters

• model (string) - The spawn name of the vehicle

Returns

• Table containing vehicle information, or nil if not found

Return Structure

{
    name = "Truffade Adder",
    brand = "Truffade",
    model = "adder",
    price = 1000000,
    hash = `adder`,
}

Usage Example

-- Get data for a specific vehicle
local vehicleInfo = exports['uz_Dealerships']:GetVehicleData('adder')

if vehicleInfo then
    print('Vehicle Name: ' .. vehicleInfo.name)
    print('Price: $' .. vehicleInfo.price)
    print('Category: ' .. vehicleInfo.category)
else
    print('Vehicle not found in dealership inventory')
end

-- Check vehicle availability before purchase
local vehicle = exports['uz_Dealerships']:GetVehicleData('t20')
if vehicle and vehicle.price <= playerMoney then
    -- Proceed with purchase logic
end

Description Fetches all configured details for a single vehicle, useful for custom purchasing systems or information displays.

---

Get All Vehicles

Retrieves the complete vehicle inventory across all dealerships.

Syntax

exports['uz_Dealerships']:GetAllVehicles()

Returns

• Table containing all vehicle entries

Return Structure

{
    ['super'] = {
        { name = 'Adder', brand = 'Truffade', model = 'adder', price = 86065, hash = `adder` },
        { name = 'Autarch', brand = 'Överflöd', model = 'autarch', price = 89600, hash = `autarch` }
    },
    ['sports'] = {
        { name = 'Jester RR', brand = 'Dinka', model = 'jester4', price = 79879, hash = `jester4` },
        { name = 'Khamelion', brand = 'Hijak', model = 'khamelion', price = 53292, hash = `khamelion` }
    }
    -- ... all configured vehicles
}

Usage Example

-- Get entire vehicle catalog
local allVehicles = exports['uz_Dealerships']:GetAllVehicles()

-- Count total vehicles
print('Total vehicles available: ' .. #allVehicles)

-- Find most expensive vehicle
local mostExpensive = nil
for _, vehicle in ipairs(allVehicles) do
    if not mostExpensive or vehicle.price > mostExpensive.price then
        mostExpensive = vehicle
    end
end
print('Most expensive: ' .. mostExpensive.name .. ' - $' .. mostExpensive.price)

-- Create custom vehicle list UI
for _, vehicle in ipairs(allVehicles) do
    -- Add to custom menu system
    AddMenuItem(vehicle.name, vehicle.price)
end

Description Returns the full vehicle database, ideal for creating custom catalogs, price comparisons, or inventory management systems.

Large inventories may impact performance. Consider caching results when possible.

---

Get Vehicles By Category

Retrieves all vehicles within a specific category.

Syntax

exports['uz_Dealerships']:GetVehiclesByCategory(categoryName)

Parameters

• categoryName (string) - The vehicle category identifier

Common Categories

• super - Super cars

• sports - Sports cars

• sportsclassics - Sports classics

• sedans - Sedans

• suvs - SUVs

• coupes - Coupes

• muscle - Muscle cars

• offroad - Off-road vehicles

• vans - Vans

• motorcycles - Motorcycles

Returns

• Table containing vehicles in the specified category

Return Structure

{
    { name = 'Adder', brand = 'Truffade', model = 'adder', price = 86065, hash = `adder` },
    { name = 'Autarch', brand = 'Överflöd', model = 'autarch', price = 89600, hash = `autarch` }
    -- ... all vehicles in category
}

Usage Example

-- Get all super cars
local superCars = exports['uz_Dealerships']:GetVehiclesByCategory('super')

-- Display category inventory
for _, vehicle in ipairs(superCars) do
    print(vehicle.name .. ' - $' .. vehicle.price)
end

-- Create category-specific dealership
RegisterCommand('luxuryshowroom', function()
    local luxuryVehicles = exports['uz_Dealerships']:GetVehiclesByCategory('super')
    -- Display custom menu with luxury vehicles only
end, false)

-- Calculate average price by category
local sedans = exports['uz_Dealerships']:GetVehiclesByCategory('sedans')
local totalPrice = 0
for _, vehicle in ipairs(sedans) do
    totalPrice = totalPrice + vehicle.price
end
local averagePrice = totalPrice / #sedans
print('Average sedan price: $' .. math.floor(averagePrice))

Description Filters vehicle inventory by category, perfect for specialized dealerships or category-based browsing systems.

Category names are case-sensitive and must match your configuration exactly.

---

Integration Examples

Custom Dealership NPC

-- Open specific showroom when player interacts with NPC
AddEventHandler('npc:interact', function(npcId)
    if npcId == 'luxury_dealer' then
        exports['uz_Dealerships']:openShowroom(1)
    elseif npcId == 'budget_dealer' then
        exports['uz_Dealerships']:openShowroom(2)
    end
end)

Price Comparison Tool

RegisterCommand('comparecars', function(source, args)
    local model1 = args[1]
    local model2 = args[2]
    
    local car1 = exports['uz_Dealerships']:GetVehicleData(model1)
    local car2 = exports['uz_Dealerships']:GetVehicleData(model2)
    
    if car1 and car2 then
        print(car1.name .. ': $' .. car1.price)
        print(car2.name .. ': $' .. car2.price)
        print('Price difference: $' .. math.abs(car1.price - car2.price))
    end
end, false)

Category Browser

RegisterCommand('browsecars', function(source, args)
    local category = args[1] or 'sports'
    local vehicles = exports['uz_Dealerships']:GetVehiclesByCategory(category)
    
    print('=== ' .. string.upper(category) .. ' VEHICLES ===')
    for i, vehicle in ipairs(vehicles) do
        print(i .. '. ' .. vehicle.name .. ' - $' .. vehicle.price)
    end
end, false)

---

Best Practices

Performance Optimization

• Cache export results when using repeatedly

• Avoid calling GetAllVehicles() in loops

• Validate dealership IDs before opening showrooms

Error Handling Always check return values before use:

local data = exports['uz_Dealerships']:GetVehicleData('invalidmodel')
if data then
    -- Safe to use data
else
    -- Handle missing vehicle
end