Properties are listed in config/config.server-only.lua, grouped by type. A property's id is <type>:<key>, e.g. house:57858 or ranch:pronghorn_ranch. Ids are stored in the database, so don't change a key once a property is in use.
Config.Properties = {
house = {
[57858] = {
label = "Winter Getaway", price = 12000,
coords = vector3(-1319.81, 2449.77, 309),
doors = {
[1073092033] = vector4(-1319.81, 2449.77, 309.0, -25.53),
},
storage = { coords = vector3(-1317.91, 2454.16, 310), weight = 500 },
},
},
ranch = {
["pronghorn_ranch"] = { ... },
},
business = {},
}
Types are just names: add any you like. Defaults for a type go in Config.PropertyTypes.
Fields¶
| Field | What it does |
|---|---|
label |
The name shown on prompts, blips and in logs. |
price |
What it costs. Leave out for a property that can't be bought (e.g. a government building handed out by command). |
coords |
Where the buy prompt is. Defaults to the first door. |
doors |
The doors to lock. See Doors. |
storage |
A stash. See Storage. |
blip |
Overrides the type's blip. A table with any of sprite, label, coords, forSale, owned, mine, or false for no blip. See Blips. |
lockable |
false for a property whose doors are never locked. Default true. |
lockpick |
Lockpicking for every door (and the storage) of this property: false for key only, or a table of minigame settings for a harder lock. Default true. |
storageLockpick |
Lockpicking for the storage only, overriding lockpick and Config.Lockpick.storage. |
keyItem |
The key item for this property. Defaults to the type's, then Config.KeyItem. |
storagePrefix |
The storage's inventory id is storagePrefix .. key (e.g. houseID_57858). Without one it's the id with : swapped for _. Usually set per type, to keep an older script's inventories. |
minGrade |
For a property owned by a job: the lowest grade that gets in. Default 0. |
Other scripts can read their own fields from the same entry. tr-ranching, for example, uses:
| Field | What it does |
|---|---|
area |
The middle of the ranch's land (vector3); animals that wander too far escape. |
animals |
How many animals the ranch can hold. |
Doors¶
Each door is keyed by its door hash. The simple form is a vector4 of the door's position and its closed heading:
doors = {
[1535511805] = vector4(-2590.84, 457.84, 146.01, -100.23),
},
For options, use a table:
doors = {
[1234567890] = vector4(x, y, z, h), -- lockable, can be picked
[2345678901] = { coords = vector4(x, y, z, h), lockpick = { pins = 5 } }, -- a harder lock
[3456789012] = { coords = vector4(x, y, z, h), lockpick = false }, -- key only
[4567890123] = { coords = vector4(x, y, z, h), lockable = false }, -- always open
[2917406796] = { coords = vector4(x, y, z, h), model = "p_door44x" }, -- an MLO door (below)
},
| Door field | What it does |
|---|---|
coords |
Position and closed heading (vector4). A door's position is its hinge. |
lockable |
false keeps this door open. |
lockpick |
false for key only, or minigame settings. Defaults to the property's. |
model |
For doors the game's door system can't lock (some MLO doors): the door's model. The door prop is then held shut directly. See Setting up a new door. |
Only list outside doors (and interior doors you want locked, like an office). Doors you leave out aren't touched.
Storage¶
storage = { coords = vector3(-1317.91, 2454.16, 310), weight = 500, radius = 1.5, lockpick = { pins = 6 } },
| Storage field | What it does |
|---|---|
coords |
Where the Open Storage prompt is. |
weight |
How much it holds. Default 500. |
radius |
How close the player needs to be. Default 1.5. |
lockpick |
false for key only, or minigame settings. See Lockpicking. |
Storage only works for types listed in Config.Storage, and only once the property is owned. Anyone carrying a key that fits can open it.