Documentation
Integrate the script with your server and connect it to your existing systems using the available developer API and events.
Returns every loaded machine, including creator-placed and hardcoded ones.
local machines = exports['qs-clawmachine']:GetMachines()Returns
tableEach entry carries the machine's position, label, price, payment method, owner and till.
Returns what is currently inside a specific machine.
local prizes = exports['qs-clawmachine']:GetMachinePrizes(machineId)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Machine id, from |
Returns
tableRefills a machine immediately, ignoring the normal restock delay and cost.
local success = exports['qs-clawmachine']:RestockMachine(machineId)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Machine id to refill |
Returns
booleanReturns false if the machine does not exist.
This bypasses the owner's restock cost. Use it for admin tooling or events, not as a substitute for the owner panel.
Returns the top players by prizes won.
local top = exports['qs-clawmachine']:GetLeaderboard(limit)Parameters
Parameter | Type | Description |
|---|---|---|
| number | How many entries to return |
Returns
tablecustom/server.lua holds GivePrizeReward() — the single function that decides what the player actually receives when a prize reaches the tray.
It auto-detects qs-inventory, ox_inventory, ESX and QB. If you run something else, point it at your own inventory here.
If detection picks the wrong resource, you can also force it from the config instead of editing the function:
Config.Rewards.inventory = 'my_inventory' -- instead of 'auto'A prize's reward accepts money, an item, or both:
reward = { money = 250 }
reward = { item = 'teddy_bear', amount = 1 }
reward = { money = 100, item = 'teddy_bear', amount = 1 }Config.Rewards.fallback is used when a prize has no reward at all, and giveItem = false makes every machine pay money only, ignoring items entirely.
The bridge lives in custom/esx/, custom/qb/ and custom/standalone/. Duplicate the closest one and implement the same functions:
Function | Purpose |
|---|---|
Identifier | Resolve the player's identifier |
Money in / out | Charge for drops, pay out rewards, handle the till |
Player name | Used by the leaderboard |
Everything else in the resource is framework-agnostic once these exist.
client/custom/main.lua exposes three functions to plug in your own systems:
Function | Purpose |
|---|---|
| Your notification resource |
| The floating |
| Hide your HUD during a run |
client/custom/target.lua holds the ox_target registration. Swap it for qb-target or any other targeting resource here — the rest of the script doesn't care which one you use.
Command | Who | What it does |
|---|---|---|
| ACE | Opens the creator / admin panel |
| ACE | Releases the nearest machine from its owner |
| ACE + | Cabinet calibration — see the Usage guide |
The creator command and its permission are both configurable:
Config.Creator.command = 'clawcreator'
Config.Creator.permission = 'command.clawcreator'local top = exports['qs-clawmachine']:GetLeaderboard(10)
for i, entry in ipairs(top) do
print(i, entry.name, entry.prizes)
endfor _, machine in pairs(exports['qs-clawmachine']:GetMachines()) do
exports['qs-clawmachine']:RestockMachine(machine.id)
endlocal prizes = exports['qs-clawmachine']:GetMachinePrizes(machineId)
if #prizes == 0 then
-- machine is empty
endAdd the entry to Config.Prizes.catalog, then tick it in the creator for the machines that should carry it:
{ id = 'teddy',
model = 'prop_bear_01',
label = 'Teddy Bear',
grip = 0.45,
color = '#f472b6',
reward = { item = 'teddy_bear', amount = 1 } },Remember to add teddy_bear to your inventory, with a matching image — a prize with no item registered pays nothing.