Tutorial / Settings
Spawn Whitelist
Players spawn from the spawn menu only what is on the list: single items, whole folders or categories, whole games, for everyone or chosen ranks and jobs.
What it does
With the spawn whitelist on, players (not toolbox admins) spawn from the spawn menu only what is on this list. It covers every kind the spawn menu has, and each kind can be freed on its own:
| Kind | Covers |
|---|---|
| Models (props, ragdolls, effects) | Props, ragdolls and effects (by model path). Toolbox tools that spawn props for players (Stack, Mirror, prefabs) follow it too. |
| Entities | Entities (by class). |
| Weapons | Weapons spawned or given from the spawn menu (by class), the Give tool, and weapons bought from players' own stores. |
| NPCs | NPCs (by class). |
| Vehicles | Vehicles (by spawn menu name). |
Each entry is one of:
| Type | Matches |
|---|---|
| One item | One model path or class. |
| Folder / category | Models: every model in a folder and its sub folders, e.g. models/props_c17/. Entities, weapons, NPCs, vehicles: every item of a spawn menu category, e.g. Half-Life 2. |
| Whole game (models) | Every model of a mounted game, e.g. cstrike (Counter-Strike: Source) or ep2. For models and for vehicles (by their model). |
An entry is for everyone, or only for the ranks and / or jobs picked for it (a player matching any one of them may spawn it).
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Spawn Whitelist.
Toolbox admins can see the list. Only superadmins change it. Toolbox admins are never limited by it.
The panel
| Control | What it does | Default |
|---|---|---|
| Spawn whitelist on | Turns the whitelist on (kgxat_spawn_whitelist). |
Off |
| Kind boxes | Ticked = that kind is whitelist-only. Unticked = players spawn any of that kind. | All ticked |
| List | Kind, Type, What, Who. Right-click a row: Remove, Copy what. | Empty |
| Remove the selected entry | Takes the selected row off. | - |
| Kind, Type, What | The entry to add. | Models, One item |
| Pick a mounted game | Fills What with a mounted game's folder and sets Type to Whole game. | - |
| Use what I am looking at | Fills What with the model or class of what you aim at. | - |
| Ranks..., Jobs... | Pick any number of ranks and jobs for the entry. None = everyone. | Everyone |
| Add to the spawn whitelist | Adds the entry. | - |
From the spawn menu
Superadmins right-click any spawn menu icon (prop, entity, weapon, NPC, vehicle) > Spawn whitelist:
| Option | What it does |
|---|---|
| Allow for everyone | Adds that item for everyone. |
| Allow for ranks / jobs... | Opens a small window to pick ranks and jobs, then adds it. |
| Allow the whole folder ... | Props only: adds the model's folder. |
How to use it
Allow only a set of props
- Tick Spawn whitelist on. Leave Models ticked; untick the kinds you do not want to limit.
- In the spawn menu, right-click each prop you want > Spawn whitelist > Allow for everyone, or Allow the whole folder.
- Players now see "Not on the spawn whitelist: ..." for anything else.
Give VIPs a whole game
- Kind Models, Type Whole game, Pick a mounted game Counter-Strike: Source.
- Ranks...: pick
vip. - Add to the spawn whitelist.
Police weapons only for the police
- Kind Weapons, Type One item, What the weapon class (or Folder / category and its spawn menu category).
- Jobs...: pick Police.
- Add to the spawn whitelist.
Settings and commands
| Setting | What it does | Default |
|---|---|---|
kgxat_spawn_whitelist |
1 = the spawn whitelist is on. | 0 |
Tips and limits
- Stored in
data/kgx_admin_toolbox/spawn_whitelist.json, up to 3000 entries. - Whole games use the games mounted on the server.
- Other rules still apply on top: RP mode props-only, spawn zones, no-build zones, limits, and the gamemode's own rules (DarkRP).
- Every change is written to the Action Log.