luckyscripts.DOCUMENTATION
LuckyScripts / Business ManagementFIVEM FIELD GUIDE

Exports reference

Connect your server resources to restaurants, menus, orders, recipes, and reporting.

Instance Manager

-- Server-side exports
exports['spc-restaurant_management']:GetRestaurant(jobName)              -- Get restaurant instance (lazy loads)
exports['spc-restaurant_management']:GetRestaurantId(jobName)            -- Get SQL ID
exports['spc-restaurant_management']:GetPlayerRestaurant(source)         -- Get player's restaurant
exports['spc-restaurant_management']:GetPlayerJobGrade(source)           -- Get player's job grade
exports['spc-restaurant_management']:HasPlayerPermission(source, perm)   -- Check permission
exports['spc-restaurant_management']:GetAllRestaurants()                 -- Get all loaded instances
exports['spc-restaurant_management']:GetRestaurantCount()                -- Count loaded restaurants
exports['spc-restaurant_management']:CreateRestaurantInstance(data)      -- Create new instance
exports['spc-restaurant_management']:InvalidateCache(jobName)            -- Clear specific cache
exports['spc-restaurant_management']:InvalidateAllCache()                -- Clear all cache
exports['spc-restaurant_management']:PreloadAllRestaurants()             -- Warm-up all restaurants
exports['spc-restaurant_management']:AddMenuItem(jobName, data)
exports['spc-restaurant_management']:RemoveMenuItem(jobName, menuId)
exports['spc-restaurant_management']:UpdateMenuItem(jobName, menuId, data)
exports['spc-restaurant_management']:GetRestaurantMenu(jobName)
exports['spc-restaurant_management']:GetMenuItem(jobName, menuId)

Order Manager

exports['spc-restaurant_management']:CreateOrder(source, jobName, items)
exports['spc-restaurant_management']:GetOrder(jobName, orderId)
exports['spc-restaurant_management']:GetRestaurantOrders(jobName, statusFilter?)
exports['spc-restaurant_management']:GetOrderQueue(jobName)
exports['spc-restaurant_management']:UpdateOrderStatus(jobName, orderId, status)
exports['spc-restaurant_management']:CancelOrder(jobName, orderId, reason?)
exports['spc-restaurant_management']:GetOrderHistory(jobName, limit?, offset?)

Recipe Manager

exports['spc-restaurant_management']:CreateRecipe(jobName, recipeData)
exports['spc-restaurant_management']:DeleteRecipe(jobName, recipeId)
exports['spc-restaurant_management']:GetRecipe(jobName, recipeId)
exports['spc-restaurant_management']:GetRestaurantRecipes(jobName)
exports['spc-restaurant_management']:GetRecipeByMenuId(jobName, menuId)
exports['spc-restaurant_management']:CanCraft(source, jobName, recipeId, isDefault, stationType)
exports['spc-restaurant_management']:ConsumeIngredients(source, recipe)
exports['spc-restaurant_management']:GetStationRecipes(jobName, stationType)
exports['spc-restaurant_management']:GetRecipeCookTime(recipe)

Kitchen Manager

exports['spc-restaurant_management']:GetPendingKitchenTasks(jobName)
exports['spc-restaurant_management']:GetStationPendingTasks(jobName, stationType)
exports['spc-restaurant_management']:GetItemStationType(jobName, itemName)
exports['spc-restaurant_management']:GetOrderProgress(jobName, orderId)
exports['spc-restaurant_management']:GetKitchenOverview(jobName)

Station Manager

exports['spc-restaurant_management']:GetCookingStationProcesses(stationType)
exports['spc-restaurant_management']:ProcessItem(source, stationType, processId)
exports['spc-restaurant_management']:AssembleRecipe(source, jobName, recipeId, isDefault, stationType, orderId?)
exports['spc-restaurant_management']:CanProcessItem(source, stationType, processId)
exports['spc-restaurant_management']:CanAssembleRecipe(source, recipe)

Settings Manager

exports['spc-restaurant_management']:AddInteractionPoint(jobName, type, coords, stationType?)
exports['spc-restaurant_management']:RemoveInteractionPoint(jobName, pointId)
exports['spc-restaurant_management']:GetInteractionPoints(jobName)
exports['spc-restaurant_management']:GetSettings(jobName)
exports['spc-restaurant_management']:UpdateSettings(jobName, settings)
exports['spc-restaurant_management']:UpdateSetting(jobName, key, value)
exports['spc-restaurant_management']:SetRestaurantOpen(jobName, isOpen)
exports['spc-restaurant_management']:IsRestaurantOpen(jobName)

Receipt Manager

exports['spc-restaurant_management']:CreateReceipt(cashierSource, metadata)
exports['spc-restaurant_management']:RedeemReceipt(source, slot, payoutMethod)
exports['spc-restaurant_management']:RedeemAllReceipts(source, payoutMethod)
exports['spc-restaurant_management']:GetReceipts(source)
exports['spc-restaurant_management']:GetTotalReceiptValue(source)

Discount Manager

exports['spc-restaurant_management']:CreateDiscount(jobName, type, percentage, targets, hours, createdBy?)
exports['spc-restaurant_management']:GetActiveDiscounts(jobName)
exports['spc-restaurant_management']:GetAllDiscounts(jobName)
exports['spc-restaurant_management']:StopDiscount(jobName, discountId)
exports['spc-restaurant_management']:CheckDiscount(jobName, menuId, category)
exports['spc-restaurant_management']:ApplyDiscount(jobName, menuId, originalPrice, category)
exports['spc-restaurant_management']:CleanupExpiredDiscounts()

Z Report Manager

exports['spc-restaurant_management']:GetOpenPeriodReport(jobName)
exports['spc-restaurant_management']:GetDailyReport(jobName)
exports['spc-restaurant_management']:GetDateRangeReport(jobName, startDate, endDate)
exports['spc-restaurant_management']:CalculateReport(restaurantId, startTime, endTime)

LuckyScripts Business Management ยท Match configuration examples to your downloaded release.
Need a hand? Read the support guide โ†—

On this page