Tutorial / Tools > World
Property
Group doors into houses, shops or offices that players buy or rent.
What it does
Property groups doors into a property: a house, shop or office. Players press Alt + E on one of its doors to buy or rent it. Owners use Alt + E to lock, unlock, give keys or sell.
A property has a name, a price, and optionally rent paid every period. You can block its doors while it is for sale, and limit who may buy it to certain jobs. Selling a bought property gives half the price back.
Map doors work as they are. Door Maker doors are made permanent by themselves when you add them (kgxat_property_autoperma). With that off, make them permanent first.
Where to find it
Q menu > KGX's Admin Toolbox > World > Property.
Toolbox admins can use it. Superadmins can also give it to players in Settings > Player Access. That tick also lets them evict, remove, rename and price every property, and reset all doors.
Admins only (v3.6.11.3): this tool sets up the server, so it cannot be given to players; it is greyed out in Settings > Player Access.
Controls
| Key | What it does |
|---|---|
| Left-click | Add the aimed door to the selected property (or start a new one) |
| E + Left-click | Block the aimed door until it is sold (a door of no property goes up for sale with the settings below); again to unblock |
| Right-click | Take the aimed door out of its property |
| Reload | Select the aimed door's property (to add more doors to it); aim at nothing to start a new one |
| E + Reload | Apply the name, price, rent and lock settings to the aimed door's property |
The screen shows Adding doors to: with the selected property's name, or Next door starts a new property.
Options
New property settings
| Option | What it does | Default |
|---|---|---|
| Name | Name of the property (up to 40 characters). | House |
| Price | Price to buy, or the rent per period. Slider 0 to 1000000000. | 500 |
| Rent (the price is paid every period) | Makes it a rental instead of a purchase. | Off |
| Rent period (hours, real time) | Length of one rent period. Slider 1 to 720. | 24 |
| Doors are blocked while it is for sale (nobody gets in until it is bought; admins can) | Keeps the doors shut until someone buys it. | On |
| Only these jobs may buy it (comma separated; empty = everyone) | Job names allowed to buy or rent it. | Empty |
| Pick the jobs... | Opens a job picker that fills the field above. | |
| The owner loses it when they leave those jobs (half back if bought) | An owner who takes another job loses the property. | Off |
| Reset to defaults | Puts these options back to their defaults. |
Properties on this map
A list with the columns Name, Price and Owner. Rentals show the price per period, for example /24h. Unowned properties show for sale. Click Refresh to reload it.
Right-click a property for:
- Go there, Rename..., Set price...
- Evict the owner (when it has one)
- Who may buy it (jobs)...
- Lock its doors, Unlock its doors, Open all its doors, Close all its doors
- Make it server property (never for sale) or Make it a normal property (for sale) (superadmins only)
- Remove property (its doors become normal doors)
Every door on the map
| Option | What it does |
|---|---|
| Reset all door health (owners kept) | Every door's health back to full. |
| Reset all door states (closed, put back, normal locks; owners kept) | Closes every door, puts it back and gives it its normal lock, after a confirmation. |
| Admins may own any number of properties | kgxat_property_admin_unlimited. Superadmins only. |
| Property doors show the property name as a sign (and the owner above it) | kgxat_property_signs. Superadmins only. |
How to use it
Make a house for sale
- Enter the Name, Price and other settings.
- Aim at nothing and press reload. The screen shows Next door starts a new property.
- Left-click the front door. This creates the property and selects it.
- Left-click every other door of the house to add it.
- Check the list: the house shows for sale.
Make a rental apartment
- Tick Rent (the price is paid every period).
- Set Price to the rent and Rent period (hours, real time) to the period.
- Start a new property and click its doors as above.
- Rent is taken from the owner's wallet at the end of each period while they are online.
Block a single door until it is sold
- Hold E and left-click the door.
- A door of no property goes up for sale on its own with the panel settings and stays shut until bought.
- A door of a property that is for sale is blocked or unblocked by itself.
- Hold E and left-click again to unblock it.
Change an existing property
- Change the settings in the panel.
- Aim at one of its doors, hold E and press reload. The settings, jobs included, go to that property.
- To add doors, aim at one of its doors and press reload to select it, then left-click the new doors.
Settings and commands
| Setting or command | What it does | Default | Range |
|---|---|---|---|
kgxat_property |
1 = properties can be bought and rented in RP mode. Off with DarkRP. | 1 | 0 to 1 |
kgxat_property_max |
Most properties one player may own or rent. | 2 | 1 to 20 |
kgxat_property_admin_unlimited |
1 = toolbox admins may own any number of properties. | 0 | 0 to 1 |
kgxat_property_signs |
1 = property doors show the property name as a sign, and the owner above it when owned. | 0 | 0 to 1 |
kgxat_property_autoperma |
1 = a Door Maker door added to a property is made permanent by itself. | 1 | 0 to 1 |
kgxat_resetdoors health |
Every door's health back to full (owners kept). | ||
kgxat_resetdoors states |
Every door closed with its normal lock (owners kept). |
Tips and limits
- Saved per map in
properties_<map>.json. - Property is part of RP mode (Settings > Gameplay > Server mode). You can set properties up in any mode.
- With DarkRP running, its own door system is used instead.
- An owner who is offline at the end of a rent period, or cannot pay, loses the property.
- Selling a rented or server property gives nothing back.
- Server property is never for sale. Only superadmins lock, unlock or take it, and it cannot be lockpicked.
- The jobs limit is ignored while jobs are off.
- Owners and key holders lock and unlock with Keys (left and right click) and open the property window with reload.
- Removing the last door from a property removes the property.