esx_property

esx_property is the official housing resource for ESX Legacy. Players buy properties from a list of 95 premade houses and apartments, enter them in their own routing bucket, give keys to friends, place furniture, store vehicles in a garage and watch a CCTV camera. Admins and an optional real estate job can create, edit and sell properties in-game.

OverviewCopy Anchor Link

Features in short:

• Buying and selling. Buying takes the price from the bank. Selling back pays 60 % of the price.
• Keys. The owner can give and remove keys. Players with keys can enter and use the property.
• Locking. Locked doors keep visitors out. Config.CanAlwaysExit and Config.OwnerCanAlwaysEnter control edge cases. Visitors can knock.
• Furniture. Furniture stores sell props by category, paid from the bank, placed and moved with keyboard controls.
• Garage. Store owned vehicles inside a property and take them out again.
• CCTV. A camera above the door with zoom and night vision. Optional Discord webhook for screenshots.
• Raids. On-duty police (and optionally admins) can break in, optionally consuming an item.
• Interiors. IPL interiors are on by default. Shell interiors need Config.Shells = true and a shell pack.

InstallationCopy Anchor Link

ensure oxmysql
ensure esx_lib
ensure es_extended
ensure esx_datastore
ensure esx_society
ensure ox_inventory
ensure esx_property

ConfigurationCopy Anchor Link

GeneralCopy Anchor Link

Prices, raids, garage, logsCopy Anchor Link

Furniture and CCTVCopy Anchor Link

Real estate job (Config.PlayerManagement)Copy Anchor Link

Config.Interiors lists the IPL and shell interiors with their spawn, wardrobe and storage positions. Config.WardrobeInteraction is a client function you can replace to use your own clothing script.

CommandsCopy Anchor Link

Command names come from the locale file and can differ if you change it.

ExportsCopy Anchor Link

ServerCopy Anchor Link

ESX.RegisterCommand('myhouses', 'user', function(xPlayer)
    local owned = exports.esx_property:GetPlayerProperties(xPlayer.getIdentifier())

    for _, property in ipairs(owned) do
        xPlayer.showNotification(property.setName ~= '' and property.setName or property.Name)
    end
end, false, { help = 'List your properties' })

A property table contains among others Name, setName, Price, Interior, Entrance, Owner, Owned, Locked, Keys, garage, cctv, furniture and positions. Treat it as read-only. Changes from other resources are not saved.

ClientCopy Anchor Link

exports.esx_property:GetProperties() returns the property data the server synced to this player. For properties without access, the server strips owner, keys, furniture and garage data.

Events and callbacksCopy Anchor Link

All interaction (buy, sell, lock, keys, furniture, garage, CCTV, raids, admin edits) goes through server callbacks named esx_property:<action>, for example esx_property:buyProperty, esx_property:toggleLock, esx_property:GiveKey and esx_property:StoreVehicle. Every callback is wrapped by a rate limiter, refuses to run while storage is not ready, validates property IDs and checks ownership, keys, admin groups or real estate grade on the server.

The client-triggerable net events are esx_property:enter, esx_property:leave, esx_property:SetVehicleOut and esx_property:server:createProperty. They are rate limited too. enter checks access and distance to the entrance, and createProperty requires admin or the CreateProperty grade and validates every field.

Client events sent by the server include esx_property:syncProperties, esx_property:syncProperty, esx_property:receivePropertyOffer, esx_property:giveKeyAccess, esx_property:RemoveKey and the furniture events (syncFurniture, loadFurniture, placeFurniture, removeFurniture, editFurniture).

Common issuesCopy Anchor Link

• "properties.json is missing or empty; SQL migration was not completed". The first start needs the shipped properties.json. Restore it, or insert at least one row and the migration marker manually if you start from scratch.
• "SQL property IDs must be contiguous". IDs in esx_properties must be 1..n without gaps. Do not delete rows by hand. Use the admin menu.
• Storage marker does nothing. Storage needs ox_inventory.
• Wardrobe is empty. Install esx_datastore and save outfits through esx_clotheshop.
• Vehicles stay "out" in your garage script. Adjust Config.Garage.MySQLquery to your schema.
• Shell interiors are black or missing. Enable Config.Shells and install the shell pack the interiors refer to.

RelatedCopy Anchor Link

• esx_society
• esx_datastore
• esx_garage
• ox_inventory with ESX
• Admin permissions

Frequently asked questions