Consumables: Exports & Events

Client exportsCopy Anchor Link

useFoodCopy Anchor Link

Uses the food in a slot, exactly as if the player used the item. If nothing is being eaten, eating starts (with the first bite when Consume.biteOnStart is on). If the same food is already being eaten, the next bite is taken. A different food gives the You are already eating something error.

ox_inventory calls it through client.export in the item definition. You can call it yourself, for example from a radial menu or a hotbar, with any supported inventory. The server reads the slot and validates everything.

exports["hype-consumables"]:useFood(nil, { name = "burger", slot = 3 })

giveFoodCopy Anchor Link

Closes ox_inventory and opens the nearby player list for the food in a slot. Pressing H again selects the next player, Y sends the offer and N cancels. It is used by the Give to someone button in the ox_inventory item definitions.

exports["hype-consumables"]:giveFood(3)

dropFoodCopy Anchor Link

Closes ox_inventory and puts the food in a slot on the ground in front of the player. It is used by the Put on the ground button. Nothing happens when Drops.enabled is false, and it is refused inside a vehicle.

exports["hype-consumables"]:dropFood(3)

Server exportsCopy Anchor Link

GetFoodInfoCopy Anchor Link

Returns a summary of the food in a player's slot, or nil when the slot holds no food. If the item has no food metadata yet (for example an item from before the script was installed), the metadata is written first.

local info = exports["hype-consumables"]:GetFoodInfo(source, 3)

if info and not info.spoiled then
    print(("%s: %s of %s %s left, %s bites"):format(info.label, info.amount, info.initialAmount, info.unit, info.bitesLeft))
end

Returns table? with these fields:

IsFoodCopy Anchor Link

Returns true when the item is defined in config/foods.lua. It does not check whether the item exists in your inventory.

if exports["hype-consumables"]:IsFood(itemName) then
    -- leave it to hype-consumables
end

EventsCopy Anchor Link

hype-consumables:server:addStatusCopy Anchor Link

Triggered on the server only in standalone mode, on every bite. Standalone servers have no built-in hunger and thirst, so apply the values from your own status or HUD resource. On QBox, QBCore and ESX the values are applied through the framework and this event is not triggered.

AddEventHandler("hype-consumables:server:addStatus", function(playerId, hunger, thirst)
    -- hunger / thirst are on a 0-100 scale, negative values remove
    exports["my-status"]:Add(playerId, "hunger", hunger)
    exports["my-status"]:Add(playerId, "thirst", thirst)
end)

my-status stands for your own resource.

hype-consumables:client:player-loadedCopy Anchor Link

A local client event the framework bridges trigger when a character is loaded. It checks the player's food on the server (missing metadata, spoiled items) and reloads the food on the ground. The script also does this once when the player joins. On a standalone server with a custom character selection, trigger it after a character is picked:

TriggerEvent("hype-consumables:client:player-loaded")

hype-consumables:client:useFoodCopy Anchor Link

The server triggers it on qb style inventories when a food item is used. Trigger it yourself to start eating from a server script:

TriggerClientEvent("hype-consumables:client:useFood", source, { name = "burger", slot = 3 })

Item metadataCopy Anchor Link

Food is a normal inventory item. Shops, crafting and jobs add it as usual, and the metadata is written by the script: right away through the createItem hook on ox_inventory, on first use or when the player joins on qb style inventories. On qb style inventories the fields are in the item info.

Bridges and modulesCopy Anchor Link

The framework bridges in frameworks/ and the modules in modules/ are open source. If your status or HUD system is customized, change Framework.Server.AddStatus in your framework's sv-main.lua; it receives hunger and thirst on a 0-100 scale.

GetModulesCopy Anchor Link

Returns the module table of the side it is called on. With a name, only that module: "Inventory" on the server, "Notify" or "Target" on the client.

local notify = exports["hype-consumables"]:GetModules("Notify")
notify.SendNotify("Food", "Enjoy your meal!", 5000, "success")

local inventory = exports["hype-consumables"]:GetModules("Inventory")
print(inventory.Name) -- "ox_inventory"