Inicio › Documentación › Personalización · origen_vendings

Personalización · origen_vendings

La carpeta custom/ contiene la capa de bridge de origen_vendings. Estos ficheros están excluidos del escrow y son los únicos que debes editar para integrar el recurso con tu stack.

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

custom/client.lua

Define dos objetos bridge usados en todo el lado cliente: HelpText y Notify.

HelpText

Controla el aviso TextUI que se muestra cuando el jugador está cerca de una máquina expendedora.

HelpText.GetResourceName() → string

Devuelve el nombre del recurso que proporciona el TextUI.

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

HelpText.ShowHelpText(message, position?)

Muestra el TextUI en pantalla. Se llama automáticamente cuando el jugador entra en el radio de interacción de una máquina.

-- 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()

Oculta el TextUI activo. Se llama automáticamente cuando el jugador sale del radio de interacción.

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

Notify

Controla las notificaciones emergentes del juego enviadas al jugador (compra correcta, errores, etc.).

Notify.GetResourceName() → string

Devuelve el nombre del recurso que proporciona las notificaciones.

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

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

Notificación sencilla sin título.

-- 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?)

Notificación con título.

-- 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

Define el objeto bridge Custom usado en todo el lado servidor. Gestiona la integración con el framework, los permisos, la economía y el inventario.

Custom.getIdentifier(source) → string | nil

Devuelve el identificador único del jugador (citizenid en QBCore/QBX, license en ESX).

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

Comprueba si el jugador tiene acceso de administración al panel de máquinas expendedoras. Devuelve 'full' si lo tiene y false en caso contrario.

Comprueba (por orden):

1. La marca de administrador del framework (qb-core / qbx_core)
2. Cualquier grupo ACE definido en Config.GroupPermissions
3. El ACE genérico command

-- 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

Devuelve el saldo del jugador en la cuenta indicada.

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

Descuenta dinero al jugador. Devuelve true si funciona, o false más una cadena de error si falla.

Posibles cadenas de error:

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

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

Entrega un objeto al jugador usando el inventario activo. Comprueba la capacidad de carga cuando está soportado.

Custom.itemExists(itemName) → boolean

Devuelve true si el objeto está registrado en el inventario activo.

Custom.getInventoryName() → string

Devuelve el nombre del recurso de inventario activo (por ejemplo 'ox_inventory', 'qb-inventory'). Útil para logs y depuración.

Custom.getAllInventoryItems() → table[]

Devuelve todos los objetos registrados en el inventario activo, ordenados alfabéticamente por etiqueta. Lo usa el panel de administración para rellenar el selector de objetos.

Cada entrada de la tabla devuelta: