Hideout
Hideout instances, guests, the stash and shell settings. Also the interior and shell preset library.
General
| Setting | Default | What it does |
|---|---|---|
BucketOffset | 1000 | Each gang's hideout is its own private world, numbered this plus the gang ID. Only change it if another script uses the same numbers |
DisablePopulation | true | No NPCs or traffic inside hideouts |
EnterDistance | 5.0 | How close to the entrance you must be to enter |
PointRadius | 1.5 | Interaction range of the entrance, desk, stash, wardrobe and exit |
FadeMs | 500 | Screen fade length when entering or leaving (milliseconds) |
AutoLeaveDistance | 250.0 | Players further than this from the interior are removed from the hideout, for example after respawning |
PoliceRaidAccess | true | Police can enter and search the stash during a raid |
StashSlots | 100 | Slots in the gang stash. Weight comes from the stash upgrade |
DefaultInterior | 1 | The interior every gang owns for free (the Starter Garage) |
Guests
| Setting | Default | What it does |
|---|---|---|
Guests.Enabled | true | Members can bring non-members inside |
Guests.Radius | 10.0 | How close players must be to be invited |
Guests.Max | 6 | Most guests per entry |
Guards
Armed NPCs at the hideout entrance, one per level of the guards upgrade. See Hideout guards.
| Setting | Default | What it does |
|---|---|---|
Guards.Enabled | true | Turns hideout guards on or off |
Guards.Models | 4 gang models | Ped models gangs can pick from. A guard with no pick uses one of these, the same one every restart |
Guards.ModelLabels | Vagos, The Lost MC, Ballas, Families | Names shown in the tablet for each model. Add a line for any model you add to Models |
Guards.Weapons | WEAPON_PISTOL, WEAPON_MICROSMG | Weapons picked at random |
Guards.Ammo | 250 | Ammo per guard |
Guards.Health / Guards.Armour | 200 / 50 | Toughness |
Guards.Accuracy | 35 | Shooting accuracy (0 to 100) |
Guards.CombatMovement | 2 | How guards move in a fight: 0 = stand still, 1 = hold position, 2 = push forward, 3 = keep their distance |
Guards.CombatAbility | 2 | Combat skill: 0 = poor, 1 = average, 2 = professional |
Guards.FiringPattern | 'FIRING_PATTERN_FULL_AUTO' | How guards fire. Any GTA firing pattern name works, e.g. 'FIRING_PATTERN_BURST_FIRE' |
Guards.Radius | { 3.0, 7.0 } | How far from the entrance guards without a placed spot stand, in metres |
Guards.PlaceRadius | 25.0 | How far from the entrance a gang can place a guard, in metres |
Guards.AlertRange | 25.0 | Trespassers this close to the entrance are attacked |
Guards.Targets | 'rivals' | 'rivals' = members of other gangs, 'everyone' = anyone who is not in the gang |
Guards.SpawnRange | 120.0 | Guards only stand while a player is this close |
Guards.RespawnMinutes | 15 | A killed guard is replaced after this |
Guards.NotifyAttack | true | Online members are told when a guard is in a fight |
Shells
| Setting | Default | What it does |
|---|---|---|
ShellsPurchasable | false | true lets gangs buy shell interiors on the tablet. false means only admins can assign shells |
ShellDepth | 200.0 | Shells spawn this far below the gang's entrance. false spawns all shells at ShellAnchor |
ShellAnchor | vec3(0.0, 0.0, -200.0) | Fixed shell position, used when ShellDepth is false |
DefaultShell | 'warehouse' | Shell used when a gang has none set. Needs K4MB1 Starter Shells |
📚 Preset library
Presets show up in Admin → Interiors → Pick from the interior library. They fill in the interior details and door position for you.
GTA interiors (shared/hideout/interiors/gta.lua)
No extra resources needed. 17 interiors:
| Category | Interiors |
|---|---|
| Apartments | Low-end, Mid-range |
| Garages | 2-car, 6-car, 10-car |
| Warehouses | Small, Medium, Large, Vehicle warehouse |
| Criminal | Clubhouse, Large clubhouse, Bunker, Meth lab, Weed farm, Coke lockup, Counterfeit cash, Document forgery |
Adding your own GTA interior:
my_interior = {
label = 'My Interior',
category = 'Apartments',
description = 'Short description',
doorCoords = vec4(x, y, z, heading), -- where players arrive
ipl = 'ipl_name', -- optional
entitySets = { 'set_one', 'set_two' }, -- optional
},Shells (shared/hideout/shells/)
| File | Needs | Shells |
|---|---|---|
k4mb1_starter.lua | K4MB1-StarterShells | 14: warehouses, container, garage, office, store, apartments, houses, motel, hotel |
k4mb1_illegal.lua | K4MB1-IllegalOperationsPack | 12: coke, meth and weed labs, acid house, laundry, gun warehouse, stash houses, bunker silo |
A shell pack is ignored while its resource isn't running.
Adding your own shell:
my_shell = {
model = 'shell_model_name',
label = 'My Shell',
category = 'Houses',
doorOffset = vec4(x, y, z, heading), -- offset from the shell's centre
},Presets are templates only. After picking one, set the desk, stash and wardrobe points and the price in Admin → Interiors.