📢EXPORTS

This documentation provides information about the export functions available in the Janiel FastFood script.

Client Exports

GetDeliveryStats

Returns player's delivery statistics.

local stats = exports['janiel-fastfood']:GetDeliveryStats()

-- Returns:
{
    level = 1,        -- Current level
    xp = 0,          -- Current XP
    orders = 0,      -- Total deliveries
    earnings = 0     -- Total earnings
}

GetDeliveryLevel

Returns player's current delivery level.

local level = exports['janiel-fastfood']:GetDeliveryLevel()

GetDeliveryXP

Returns player's current XP amount.

local xp = exports['janiel-fastfood']:GetDeliveryXP()

IsDeliveryActive

Checks if player is currently on an active delivery.

local isActive = exports['janiel-fastfood']:IsDeliveryActive()

Server Exports

AddDeliveryXP

Adds XP to player's delivery experience.

exports['janiel-fastfood']:AddDeliveryXP(source, amount)

-- Example:
exports['janiel-fastfood']:AddDeliveryXP(source, 100) -- Adds 100 XP

SetDeliveryMultiplier

Sets the payment multiplier for deliveries.

exports['janiel-fastfood']:SetDeliveryMultiplier(source, multiplier)

-- Example:
exports['janiel-fastfood']:SetDeliveryMultiplier(source, 1.5) -- 1.5x payment

SetDeliverySpeedMultiplier

Sets the speed multiplier for deliveries.

exports['janiel-fastfood']:SetDeliverySpeedMultiplier(source, multiplier)

-- Example:
exports['janiel-fastfood']:SetDeliverySpeedMultiplier(source, 1.3) -- 1.3x speed

GetPlayerDeliveryStats

Returns all delivery statistics for a player.

local stats = exports['janiel-fastfood']:GetPlayerDeliveryStats(source)

-- Returns:
{
    level = 1,                    -- Current level
    xp = 0,                      -- Current XP
    orders = 0,                  -- Total deliveries
    earnings = 0,                -- Total earnings
    multiplier = 1.0,            -- Payment multiplier
    speedMultiplier = 1.0        -- Speed multiplier
}

Integration Examples

Level-Based Payment Bonus

-- When player levels up in skill tree
local level = exports['janiel-fastfood']:GetDeliveryLevel()
local multiplier = 1.0 + (level * 0.1) -- 10% bonus per level
exports['janiel-fastfood']:SetDeliveryMultiplier(source, multiplier)

Level-Based Speed Bonus

-- When player levels up in skill tree
local level = exports['janiel-fastfood']:GetDeliveryLevel()
local speedMultiplier = 1.0 + (level * 0.05) -- 5% speed bonus per level
exports['janiel-fastfood']:SetDeliverySpeedMultiplier(source, speedMultiplier)

XP and Level System

-- When delivery is completed
local baseXP = 50 -- Base XP amount
local level = exports['janiel-fastfood']:GetDeliveryLevel()
local bonusXP = baseXP * (level * 0.1) -- 10% bonus XP per level
exports['janiel-fastfood']:AddDeliveryXP(source, baseXP + bonusXP)

Important Notes

  1. All exports are defined in fxmanifest.lua

  2. Client exports can only be used in client scripts

  3. Server exports can only be used in server scripts

  4. Multipliers cannot be less than 1.0

  5. XP and level system is automatically saved to database

Last updated