Commands#

Housing Creator registers a few in-game commands, two of them with keybinds players can change in their FiveM settings. Command names that come from the config can be renamed there.

Command	Who	Description
`/houseMenu` · F3	Owners, tenants, key holders	Opens the management panel of the house you are at. Outside an apartment building it lists your apartments. Key: `Config.OpenHouseMenu`; `Config.DisableHouseMenuKeybind` turns both off.
`/realestate` · F7	Admins, real estate jobs	Opens the creator: houses, furniture shops and agencies. Key: `Config.OpenJobMenu`.
`/housebrowser`	Everyone	Opens the house browser. Only when `Config.HouseBrowserCommand = true`.
`/agencymenu`	Agency members with boss menu access	Opens the real estate agency boss menu. Name and optional key in `Config.Agency.bossMenuAccess`.
`/hireRenter`	Admins, real estate jobs	Standing at a house, evicts its tenant (it stays listed for rent). In an apartment building it lists the rented units. Name: `Config.HireRenterCommand`.
`/housingfurniture`	Admins	Opens the furniture creator: add, edit and photograph catalogue items. Name: `Config.FurniCreatorCommand`.
`/houseload`	Everyone	Sends every house to your client again — for when houses or blips did not load on join.
`revert_decorations`	Server console	One-time migration for servers coming from a very old version: moves furniture from the old storage format to the current one, then asks for a restart.

revert_decorations changes your database. Back it up first, and run it only when moving from an old version. While Config.Debug is on, a few developer commands are registered too; they disappear when it is off.

Client Exports#

For HUDs, radial menus, spawn selectors and anything else that needs to know where the player is.

Where the player is

lua

exports['qs-housing']:getEnteredHouse()     -- house the player is inside, or nil
exports['qs-housing']:getCurrentHouse()     -- house whose zone the player is in (outside too), or nil
exports['qs-housing']:GetCurrentHouseData() -- access to the current house (below)
exports['qs-housing']:GetCurrentHouseUpgrades() -- upgrades of the current house

GetCurrentHouseData returns haskey, isOwned, isOfficialOwner, rentable, purchasable, houseRented, billsCutOff, lightsOn and more.

lua

local house = exports['qs-housing']:getEnteredHouse()
if house and exports['qs-housing']:GetCurrentHouseData().haskey then
    print('At home in', house)
end

House data

lua

exports['qs-housing']:getHouseData(house) -- one house: coords, price, interior, upgrades...
exports['qs-housing']:getHouseList()      -- every house (waits until houses are loaded)
exports['qs-housing']:getShells()         -- the shell list from the config (client and server)

Entering and leaving

lua

exports['qs-housing']:enterHouse(house, false)  -- teleports the player in, without checking keys
exports['qs-housing']:CleanupPlayerHousingState() -- forces the player out of every housing state

Call CleanupPlayerHousingState from a multicharacter or logout script before switching characters.

Interfaces

lua

exports['qs-housing']:OpenPropertyHub(house, houseData, currentHouseData)
exports['qs-housing']:ClosePropertyHub()
exports['qs-housing']:OpenAgencyBossMenu(agencyId)
exports['qs-housing']:inDecorate() -- true while decorate mode is open

Security cameras

lua

local cams = exports['qs-housing']:GetSecurityCameras() -- { { id = 12 }, ... }
if cams[1] then
    exports['qs-housing']:WatchSecurityCamera(cams[1].id)
end

Shells

Add a shell from another resource without editing the config:

lua

exports['qs-housing']:AddShell({ model = 'my_shell_model', stash = { maxweight = 1000000, slots = 10 } })

Server Exports#

How other resources drive Housing Creator. target means a player's server id or their identifier (citizenid on QBCore).

Reading ownership

lua

exports['qs-housing']:GetPlayerHouses(source)                  -- { 'house_1', ... } owned or rented
exports['qs-housing']:GetPlayerPropertiesByIdentifier(identifier) -- with label, address, coords, image; works offline
exports['qs-housing']:GetHouseOwner(house)                     -- identifier, 'realestate' or 'agency_<id>'
exports['qs-housing']:GetPlayerInsideHouse(source)             -- the house the player is saved inside
exports['qs-housing']:CheckHasKey(identifier, identifier, house, source)
exports['qs-housing']:CanOwnAnotherHouse(identifier)           -- under the house limit (VIP slots included)

Giving and taking houses

lua

local ok, err = exports['qs-housing']:AssignHouseToPlayer(target, house, { notify = true, skipMaxLimit = false })
-- err: invalid_house, invalid_target, house_not_found, house_already_owned, max_houses_reached

exports['qs-housing']:ClearHouseOwnership(house, { notify = true }) -- back on the market
exports['qs-housing']:ReleaseRenter(house, true)                    -- evict the tenant, keep it listed
exports['qs-housing']:BankHandover(house, identifier)               -- bank deal; nil returns it to market
exports['qs-housing']:deleteHouse(house)                            -- deletes the house completely

None of these charge money. AssignHouseToPlayer is the export for rewards, starter homes and admin tools.

Character deletion and stuck players

lua

local ok, summary = exports['qs-housing']:OnCharacterWipe(identifier)
-- summary = { released = {...}, cleared = {...}, transferred = {...} }

exports['qs-housing']:ClearPlayerInsideByIdentifier(identifier) -- player spawns outside next time

OnCharacterWipe ends rentals, clears or hands over owned houses, and removes the character from every key list. Call it from your character-delete script.

Keys

lua

exports['qs-housing']:GiveMetaKey(source, house)     -- gives a new physical key item
exports['qs-housing']:RemoveMetaKey(source, house)
exports['qs-housing']:CheckHasMetaKey(source, house)

Available while Config.EnableMetaKey is on.

Payments: mortgage, rent and bills

For banking apps and phone apps. Quote first, take the money your own way, then confirm:

lua

local quote = exports['qs-housing']:QuoteHousingPayment(target, house, 'mortgage') -- 'mortgage' | 'rent' | 'bill'
if quote.ok and MyBank.Charge(target, quote.amount) then
    exports['qs-housing']:ConfirmHousingPayment(target, house, 'mortgage', { alreadyCollected = true })
end

-- Without alreadyCollected, Housing Creator charges the player itself.
exports['qs-housing']:PayHouseMortgage(target, house, {})
exports['qs-housing']:PayHouseRent(target, house, {})
exports['qs-housing']:PayHouseBill(source, billId)

To read everything a player is tied to — owned, rented, keys, mortgage, rent due, unpaid bills:

lua

local result = exports['qs-housing']:GetPlayerHousingContracts(target)
local one    = exports['qs-housing']:GetHouseContract(house, target)

Config.HousingApps.AllowedResources limits which resources may call these. Empty means any. With SkipAutoChargeOnExternalPay, a payment made this way skips the next automatic charge.

VIP houses

lua

exports['qs-housing']:GrantVipHouse(target, house, { notify = true }) -- free, skips the house limit
exports['qs-housing']:RevokeVipHouse(house)
exports['qs-housing']:SetVipExtraHouseSlots(identifier, 2)           -- added to Config.MaxOwnedHouses
exports['qs-housing']:GetVipExtraHouseSlots(identifier)

Blocking sales and transfers

Take a house off the market completely — it cannot be bought, rented or mortgaged, and disappears from the browser and map:

lua

exports['qs-housing']:SetHouseForSale(house, false)
exports['qs-housing']:IsHouseForSale(house)

Or veto specific player actions with your own rules:

lua

exports['qs-housing']:RegisterHouseTransactionVeto('gang_rules', function(ctx)
    -- ctx.action: 'sell_bank', 'list_player_sale', 'buy_from_player' or 'transfer'
    if ctx.action == 'transfer' and IsGangHouse(ctx.house) then
        return false, 'Gang houses cannot be transferred'
    end
    return true
end)

exports['qs-housing']:UnregisterHouseTransactionVeto('gang_rules')

Furniture

Add items to an existing catalogue category (how the [dlc] packs work), or place furniture in a house:

lua

exports['qs-housing']:AddFurniture('sofa', {
    object = 'my_sofa', label = 'My Sofa', price = 1200,
    description = 'Comfortable.', img = 'https://example.com/my_sofa.webp',
    colorlabel = 'Grey', colors = {},
})

exports['qs-housing']:addDecorationToHouse(house, {
    modelName = 'my_sofa',
    coords = vec3(0.0, 0.0, 0.0),
    rotation = vec3(0.0, 0.0, 0.0),
    inStash = true,  -- true: goes to the owner's furniture stash
    inHouse = false,
})
exports['qs-housing']:addDecorationBatchToHouse(house, { ... })

Agencies

lua

exports['qs-housing']:GetAgencyById(id)
exports['qs-housing']:GetAgencyByName(name)
exports['qs-housing']:GetPlayerAgencyMembership(identifier) -- agency, rank and permissions
exports['qs-housing']:CanManageHouse(source, house)         -- owner or agency manager
exports['qs-housing']:ResolveAgencyIdForHouse(house)

After changing data yourself

lua

exports['qs-housing']:RefreshHouseCache(house, 'bills') -- 'bills', 'house_meta_keys' or 'meta_key_valid'

Events#

Server events to listen to with AddEventHandler:

Event	Fires when
`qs-housing:server:contractUpdated`	`(action, payload)` — bought, assigned, cleared, handover, mortgage_paid, rent_paid, rent_failed, bill_paid, keys_updated, vip_slots_updated.
`qs-housing:server:houseCreated` · `houseUpdated` · `houseDeleted`	A house is created, edited or deleted in the creator.
`housing:handleBuyHouse`	`(source, house, price, isCredit)` — a house is bought or assigned.
`housing:handleRentPayment`	`(house, identifier, paid)` — a rent charge succeeded (1) or failed (0).
`qs-housing:billPaid`	`(source, house, billId, total)`

Client events:

lua

AddEventHandler('housing:onEnterHouse', function(house) end)    -- entered a house interior
AddEventHandler('housing:onExitHouse', function(house) end)
AddEventHandler('housing:handleEnterZone', function(house) end) -- walked into a property zone
AddEventHandler('housing:handleExitZone', function(house) end)
RegisterNetEvent('qs-housing:client:contractUpdated', function(data) end) -- { house, action }

Compatibility with qb-houses#

Scripts written for qb-houses keep working: exports['qb-houses']:hasKey(...) is answered by Housing Creator, and spawn selectors can still trigger qb-houses:client:enterOwnedHouse and qb-houses:client:LastLocationHouse. The console reminds you to move those scripts to the qs-housing exports; do not run the real qb-houses alongside.

Commands andExports

Commands#

Client Exports#

Server Exports#

Events#

Compatibility with qb-houses#

Commands andExports

Commands#

Client Exports#

Server Exports#

Events#

Compatibility with qb-houses#

Commands andExports

Commands#

Client Exports#

Server Exports#

Events#

Compatibility with qb-houses#

Commands andExports

Commands#

Client Exports#

Server Exports#

Events#

Compatibility with qb-houses#