Custom · origen_vendings

The custom/ folder contains the bridge layer for origen_vendings. These files are excluded from escrow and are the only files you should edit to integrate the resource with your stack.

custom/
├── client.lua   ← TextUI and notification bridges
└── server.lua   ← Framework, permissions, economy, and inventory bridges

custom/client.lua

Defines two bridge objects used across the entire client side: HelpText and Notify.

HelpText

Controls the TextUI prompt shown when the player is near a vending machine.

HelpText.GetResourceName() → string

Returns the name of the resource providing the TextUI.

HelpText.GetResourceName = function()
    return 'ox_lib'
end

HelpText.ShowHelpText(message, position?)

Shows the TextUI on screen. Called automatically when the player enters a machine's interaction radius.

-- Default implementation (ox_lib)
HelpText.ShowHelpText = function(message, position)
    exports.ox_lib:showTextUI(message, {
        position = position or 'left-center',
        icon     = 'shopping-cart',
    })
end

HelpText.HideHelpText()

Hides the active TextUI. Called automatically when the player leaves the interaction radius.

-- Default implementation (ox_lib)
HelpText.HideHelpText = function()
    exports.ox_lib:hideTextUI()
end

Notify

Controls in-game toast notifications sent to the player (purchase success, errors, etc.).

Notify.GetResourceName() → string

Returns the name of the resource providing notifications.

Notify.GetResourceName = function()
    return 'ox_lib'
end

Notify.SendNotify(message, type?, time?)

Simple notification without a title.

-- Default implementation (ox_lib)
Notify.SendNotify = function(message, _type, time)
    exports.ox_lib:notify({
        description = message,
        type        = _type or 'info',
        duration    = time  or 3000,
        position    = Config.NotificationPosition or 'top-right',
    })
end

Notify.SendNotification(title, message, type?, time?)

Notification with a title.

-- Default implementation (ox_lib)
Notify.SendNotification = function(title, message, _type, time)
    exports.ox_lib:notify({
        title       = title or 'Vending',
        description = message,
        type        = _type or 'info',
        duration    = time  or 3000,
        position    = Config.NotificationPosition or 'top-right',
    })
end

custom/server.lua

Defines the Custom bridge object used across the entire server side. Handles framework integration, permissions, economy, and inventory.

Custom.getIdentifier(source) → string | nil

Returns the player's unique identifier (citizenid for QBCore/QBX, license for ESX).

Custom.getStaffLevel(source) → 'full' | false

Checks if the player has admin access to the vending panel. Returns 'full' if they do, false otherwise.

Checks (in order):

1. Framework admin flag (qb-core / qbx_core)
2. Any ACE group defined in Config.GroupPermissions
3. The generic command ACE ace

-- Usage example inside a callback
local level = Custom.getStaffLevel(source)
if not level then return end -- not an admin

Custom.getMoney(source, account?) → number | nil

Returns the player's balance in the given account.

Custom.removeMoney(source, amount, account?, reason?) → boolean, string?

Deducts money from the player. Returns true on success, or false plus an error string on failure.

Possible error strings:

local ok, err = Custom.removeMoney(source, 50, 'cash')
if not ok then
    print('Payment failed:', err)
end

Custom.giveItem(source, itemName, amount, metadata?) → boolean

Gives an item to the player using the active inventory. Checks carry capacity when supported.

Custom.itemExists(itemName) → boolean

Returns true if the item is registered in the active inventory.

Custom.getInventoryName() → string

Returns the name of the currently active inventory resource (e.g. 'ox_inventory', 'qb-inventory'). Useful for logs and debugging.

Custom.getAllInventoryItems() → table[]

Returns all items registered in the active inventory, sorted alphabetically by label. Used by the admin panel to populate the item selector.

Each entry in the returned table: