Tutorial / Tools > Functions
Jail
Lock players in a cell where they stand, or take them to a jail location.
What it does
Jail locks a player in a cell. You can jail them where they stand, or take them to a jail location you set up on the map, like a sit room. A jailed player who leaves the cell is pulled back.
Jailed players cannot noclip, spawn things, use tools, use the physgun or enter vehicles. Their weapons are taken and come back on release. By default they are frozen and can only look around.
Jail survives death, reconnecting, map changes and restarts (saved in jail_pending.json; after a map change the player is jailed again by this map's jail rules; not after 30 days away). kgxat_unjailid <SteamID> (server console or a superadmin) releases someone who is offline. A timed jail shows a countdown to the prisoner and to admins, and the time continues where it stopped after a rejoin.
Where to find it
Q menu > KGX's Admin Toolbox > Functions > Jail.
Admin only by default. Superadmins can give it to players or ranks in Settings > Player Access. Rank immunity applies. The Jail locations (superadmins) settings in the panel can only be changed by superadmins.
Other ways in:
- Utilities > Player Manager: right-click a player > Toggle jail or Jail at.
- Chat:
!jail <name>toggles jail (needskgxat_chat_commandson).
Given to a player (v3.6.11.3): Where the target stands, 10 s to 5 min, only with kgxat_grant_others; release only their own.
Controls
| Key | What it does |
|---|---|
| Left click | Jail the aimed player at the place chosen with Reload |
| E + Left click | Jail them where they stand (ignores jail locations and the menu) |
| Right click | Release the aimed player |
| Reload | Choose where to jail: Ask (menu), Automatic, Where they stand, then each jail location |
| E + Reload | Release everyone (press twice within 3 seconds) |
In draw mode (Tool does set to Draw):
| Key | What it does |
|---|---|
| Left click | Add a node. Click the first node again to finish. |
| Right click | Finish the jail (3 or more nodes) |
| Reload | Remove the last node |
| E + Reload | Clear all nodes |
The panel
Tool settings
| Option | What it does | Default |
|---|---|---|
| Tool does | Jail players or Draw a jail with nodes (any shape) | Jail players |
| Jail time in seconds (0 = until released) | Time for jails made with this tool, 0 to 86400 | 0 |
| Jumpscares (faces, screams, footsteps, blackouts...) | Prisoners get random jumpscares | Off |
| Black box (a black cube around the cell; they cannot see out) | Puts a black cube around the prisoner | Off |
| Reset to defaults | Puts the tool options back | - |
Jail locations (superadmins)
| Option | What it does | Default |
|---|---|---|
| Take jailed players to a jail location (when this map has one) | Automatic jails go to a jail location | Off |
| New locations are cells with bars (off = jail rooms: players are kept inside the radius) | Type for new locations | On |
| New locations send them back to where they were when released | Return on release for new locations | On |
| Jailed players are frozen (only look around); off = they can walk inside. Locations can have their own | Freeze prisoners | On |
| Ask which jail location when jailing (Jail tool, Player Manager) | Shows the location menu when you jail someone | On |
| Which location | The first free location, A random free location or The nearest free location | First free |
| Player Manager / !jail time in minutes (0 = until released) | Time for jails from the Player Manager and chat, 0 to 1440 | 0 |
| Player Manager / !jail: jumpscares | Jumpscares for those jails | Off |
| Player Manager / !jail: black box | Black box for those jails | Off |
| Seconds between jumpscares (about) | Average gap between jumpscares, 5 to 300 | 30 |
| Show the names of jail locations above them to everyone | Name labels for all players | Off |
| Apply the numbers above | Saves the two sliders | - |
Jail locations on this map
| Option | What it does | Default |
|---|---|---|
| Radius of new locations (jail rooms) | Radius for new jail rooms, 48 to 1024 | 128 |
| Name for the next drawn jail | Name given to the next drawn jail | Empty |
| Location list | Columns #, Location and Distance. Double-click to go there. Right-click for Go there, Rename..., Settings of this location..., Copy position and Remove. | - |
| Add a jail location where I stand... | Saves a location at your feet, facing your view direction. Asks for an optional name. | - |
| Refresh | Reloads the list | - |
| Remove all jail locations on this map... | Deletes every location after a confirmation | - |
Jail location settings
A location's own window opens when you add it, or from Settings of this location.... Click Save when done.
| Option | What it does |
|---|---|
| Name | Name of the location |
| Type | Cell with bars (one prisoner) or Jail room, no bars (any number, kept inside the radius). Not shown for drawn jails. |
| Room radius | Radius of a jail room, 48 to 1024 |
| Bars along the outline | Drawn jails only: a fence of bars along the outline while someone is inside |
| Own jail time (else whoever jails decides) and Jail time in minutes (0 = until released) | Fixed time for this location, 0 to 240 minutes |
| Jumpscares | Jumpscares here |
| Own time between jumpscares and Seconds between jumpscares (about) | Own gap, 5 to 300 seconds |
| Black box (they cannot see out) | Black box here |
| Send them back where they were when released | Return on release |
| Frozen: they can only look around (off: they can walk inside) | Freeze here |
| Police jail: the Police Jail Baton and handcuffed players dropped here use it | Marks it as a police jail |
How to use it
Jail a player where they stand
- Hold E and left-click the player.
- Bars appear around them. Right-click them to release.
Set up jail locations
- Stand in the middle of the cell or room and face the way prisoners should look.
- Press Add a jail location where I stand... and give it a name.
- Pick the type and other settings in the window that opens, then Save.
- As a superadmin, tick Take jailed players to a jail location (when this map has one).
Jail at a chosen place
- Press Reload until the HUD shows the choice you want.
- With Ask (menu), left-click the player. A menu lists the jail locations, Where they stand, Automatic and Cancel.
- With any other choice, left-click jails them there at once.
Draw a jail of any shape
- Set Tool does to Draw a jail with nodes (any shape) and type a name.
- Left-click points around the area, up to 32.
- Click the first node again or right-click to finish.
- Set Tool does back to Jail players.
Settings and commands
| Setting or command | What it does | Default / range |
|---|---|---|
kgxat_jail_locations |
Take jailed players to a location | 0 (0/1) |
kgxat_jail_bars |
New locations are cells with bars | 1 (0/1) |
kgxat_jail_return |
Send back on release | 1 (0/1) |
kgxat_jail_freeze |
Prisoners are frozen | 1 (0/1) |
kgxat_jail_ask |
Ask which location | 1 (0/1) |
kgxat_jail_pick |
0 = first, 1 = random, 2 = nearest free | 0 (0-2) |
kgxat_jail_minutes |
Player Manager / !jail minutes |
0 (0-1440) |
kgxat_jail_scares |
Player Manager / !jail jumpscares |
0 (0/1) |
kgxat_jail_box |
Player Manager / !jail black box |
0 (0/1) |
kgxat_jail_scare_every |
Seconds between jumpscares | 30 (5-300) |
kgxat_jail_names |
Location names shown to everyone | 0 (0/1) |
!jail <name> |
Toggle jail on a player | - |
!unjailme / kgxat_unjailme |
Leave a jail you put yourself in | - |
kgxat_unblock <name> |
Server console or superadmin: also releases from jail | - |
Tips and limits
- A cell holds one prisoner. When every cell is taken, the player is jailed where they stand with a notice.
- A jail room or drawn jail holds any number of players, each on their own spot.
- Jail locations are saved per map in
data/kgx_admin_toolbox/jails_<map>.json. - Locations show while you hold the tool and with Admin Vision markers.
- You cannot jail yourself with the tool. Use Player Manager > right-click yourself > Toggle jail, then
!unjailme. - Jumpscares and the black box can be switched for someone already jailed: Player Manager > right-click a jailed player.
- With superadmin override on (
kgxat_superadmin_override), E + Reload releases everyone on the first press.