Documentation
Quasar Housing includes several commands for administrators, property managers, and developers. These commands allow you to create properties, manage houses, debug systems, and access different housing tools.
/housebrowser#Opens the remote property browser.
Players can use this menu to explore available properties, check prices, and discover houses without physically visiting every location.
/houseMenu#Opens the property management menu.
Inside owned properties, players can manage:
House keys.
Upgrades.
Bills.
Furniture.
Property settings.
Other available home features.
/realestate#Opens the property creator.
This command allows administrators to create and configure new properties directly inside the game.
Features include:
Creating house entrances.
Selecting interiors.
Configuring garages.
Adding stash and wardrobe points.
Setting property information.
/agencymenu#Opens the real estate agency management menu.
Used by agency owners and authorized members to manage:
Employees.
Agency properties.
Finances.
Listings.
Agency permissions.
/housingfurniture#Opens the furniture creator and thumbnail capture system.
Administrators can create custom furniture entries, capture images, and manage furniture catalog content.
/houseload#Reloads housing data from the database.
Useful after making external database changes or restoring property information without restarting the entire server.
/revert_decorations#Restores previous furniture decoration states.
Useful for administrators when testing decorations or reverting unwanted changes.
/resetentrycoords#Fixes legacy shell entry coordinates.
This command is mainly used for older properties that require coordinate correction.
/hireRenter#Removes tenants from rental properties.
This command is controlled by:
Config.HireRenterCommandand allows authorized users to manage problematic rental situations.
The following commands are intended for development and configuration:
Command | Purpose |
|---|---|
| Opens furniture positioning tools. |
| Captures object offsets. |
| Updates furniture offsets. |
| Debugs pet object attachment. |
Returns the property where the player is currently located.
local house = exports['qs-housing']:getCurrentHouse()Returns:
string | nilReturns the property the player is currently inside.
local house = exports['qs-housing']:getEnteredHouse()Returns:
string | nilRetrieves information about a specific property.
local data = exports['qs-housing']:getHouseData('house_name')Returns the complete property data table.
Force enters a property.
exports['qs-housing']:enterHouse(
'house_name',
false
)Parameters:
Parameter | Type | Description |
|---|---|---|
| string | Property name |
| boolean | Enter as visitor |
Opens the property management interface.
exports['qs-housing']:OpenPropertyHub(
houseName,
houseData,
currentHouseData
)External resources can register furniture dynamically.
exports['qs-housing']:AddFurniture(
category,
item
)Retrieve cameras from the current property:
local cameras = exports['qs-housing']:GetSecurityCameras()Open a camera view:
exports['qs-housing']:WatchSecurityCamera(cameraId)Quasar Housing provides multiple server-side exports designed for advanced integrations with external resources. These exports allow developers to manage properties, ownership, keys, decorations, agencies, and player housing data directly from other scripts.
Returns all properties owned by a player.
local houses = exports['qs-housing']:GetPlayerHouses(source)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Player server ID |
Returns
tableReturns all properties assigned to the player.
Retrieves owned properties using an identifier instead of an online player.
local houses = exports['qs-housing']:GetPlayerPropertiesByIdentifier(identifier)Useful for:
Offline management systems.
Phone integrations.
External administration tools.
Returns the current owner of a property.
local owner = exports['qs-housing']:GetHouseOwner(
'house_name'
)Parameters
Parameter | Type |
|---|---|
| string |
Checks which property a player is currently inside.
local house = exports['qs-housing']:GetPlayerInsideHouse(source)Returns:
string | nilChecks whether a player has access to a property.
local hasAccess = exports['qs-housing']:CheckHasKey(
identifier,
citizenId,
house,
source
)Useful for:
Door systems.
Phone integrations.
Security resources
Gives ownership of a property to a player.
exports['qs-housing']:AssignHouseToPlayer(
target,
'house_name',
options
)Parameters:
Parameter | Type | Description |
|---|---|---|
| number | Player ID |
| string | Property name |
| table | Additional ownership settings |
Removes ownership from a property.
exports['qs-housing']:ClearHouseOwnership(
'house_name',
options
)Useful for:
Admin tools.
Property resets.
Custom marketplaces.
Deletes a property from the database.
exports['qs-housing']:deleteHouse(
'house_name'
)External resources can add or manage furniture directly through the housing system.
Adds a single furniture object to a property.
exports['qs-housing']:addDecorationToHouse(
house,
decorationData
)Adds multiple furniture objects at once.
exports['qs-housing']:addDecorationBatchToHouse(
house,
entries
)Useful for:
Preset interiors.
Event houses.
Custom apartments.
Adds furniture dynamically.
exports['qs-housing']:AddFurniture(
category,
item
)Checks if a player owns a physical house key.
local hasKey = exports['qs-housing']:CheckHasMetaKey(
source,
house
)Creates and gives a property key item.
exports['qs-housing']:GiveMetaKey(
source,
house,
keyId
)Removes a house key from a player.
exports['qs-housing']:RemoveMetaKey(
source,
house
)Quasar Housing includes exports for integrating custom real estate systems.
Developers can:
Check agency ownership.
Retrieve agency information.
Manage property transfers.
Log agency activity.
Validate permissions.
Available exports include:
GetAgencyById
GetAgencyByName
GetPlayerAgencyMembership
CanManageAgencyProperty
CheckAgencyHouseAccess
CheckAgencyPropertyAccess
ResolveAgencyIdForHouse
SyncAgencyHouseOwnership
LogAgencyActivityExternal resources can control housing transactions.
Blocks purchases or sales when custom conditions are met.
exports['qs-housing']:RegisterHouseTransactionVeto(
'my_check',
function(source, house, action)
return true
end
)Example:
exports['qs-housing']:RegisterHouseTransactionVeto(
'police_lockdown',
function(source, house, action)
if action == 'buy' then
return false, 'Property sales are disabled'
end
return true
end
)Housing provides exports designed for phone resources.
Available functions:
PhoneHasHouseAccess
PhoneCapabilitiesTableThese allow phone systems to verify property ownership and access permissions.