Renaming Commands#
Every command name below is the default. All of them are editable in Settings → Commands, so a server that already uses a name can change it without touching a file.
Player Commands#
Anyone can type these, but each one checks the right thing — you must be inside your own arcade, or hold the right the action needs.
Command | What it does |
|---|---|
| Opens the business panel. Also on |
| Opens the machine placer. Needs the Place machines right. |
| Opens the decor editors: floor, mural, neon and the pillar screens. |
| Opens the RGB rig: effect, colour, speed and brightness. |
| Previews a decoration before paying for it. |
| Opens the jukebox: in-house stations, the game's radio, or a YouTube link. |
| Takes money out of the safe, or puts money in. Needs the Open the safe right. |
| Sells the arcade you are standing in. Owner only. |
| Locks and unlocks the interior doors. Needs the Open doors right. |
Admin Commands#
These two open the panels that configure the whole server, so they are behind an ace. Grant them in server.cfg:
add_ace group.admin command.arcadeconfig allow
add_ace group.admin command.arcadecreator allowCommand | What it does |
|---|---|
| The venue creator: place a new arcade, edit one, move its door, retake its photos, or delete it. |
| The settings panel: 166 options in 17 sections, saved live. |
| Guarantees the next claw-machine grab. For testing the plushies. Needs |
Diagnostic Commands#
These print to the F8 console and change nothing, so they are safe for anyone to type. They are the fastest way to answer "why is this not working" before opening a ticket.
Command | Prints |
|---|---|
| Which arcade you are in, who owns it, and what the client thinks its state is. |
| The purchase ledger: which machines and upgrades this venue has paid for. |
| The safe: its balance and the props representing it. |
| The pillar screens, and which interior entity sets are active right now. |
| The barmaid's state, and the claw machine's. |
| Developer tools, only while |
| Nudge an add-on machine into place and print its offset; hold a plushie to check its prop. |
Server Console Commands#
Typed in the server console, not in chat. They use command.<name> aces, so rename one and you rename its ace with it.
Command | What it does |
|---|---|
| Lists every arcade with its owner and how many machines it holds. |
| Lists every venue the creator has placed, with its id, label and price. |
| Releases every arcade back onto the market. Useful on a test server, destructive on a live one. |
| Dump the stored state of the lights, the jukebox and the decor for every venue. |
Exports#
IsInsideArcade#
Client side. Returns the id of the arcade the player is standing in, or nil if they are outside. The id is the same one the creator and the database use.
local id = exports['qs-arcades']:IsInsideArcade()
if id then
print(('the player is inside arcade %s'):format(id))
endThis is what most integrations need. A few of the things it is used for:
Stopping a dispatch, a robbery or an AI script from firing inside a venue.
Letting a HUD hide itself, or a voice script switch channel, while a player is indoors.
Refusing to spawn a vehicle somewhere the player cannot actually be.
-- Don't let a robbery start while the player is inside an arcade
CreateThread(function()
while true do
if exports['qs-arcades']:IsInsideArcade() then
-- indoors: skip this tick
else
-- outdoors: carry on as normal
end
Wait(1000)
end
end)Putting your own cabinet on the arcade floor is not done with an export. Add-on machines are declared in
shared/external.luaand then run by your own resource — see Integrations.