QBESXStandalone
Agency-Housing Exports & API
Database driven housing system for FiveM.
v1.1.0Paid5 Pages
01Client Exports
| Export | Description |
|---|---|
IsInsideHouse() | Returns true while the player is inside a house. |
GetCurrentHouse() | The house the player is currently inside, or nil. |
LeaveHouse() | Puts the player back outside through the entrance. |
GetHouseAtPoint(coords) | The first house whose property border owns this ground. |
GetHousesAtPoint(coords) | Every house owning this ground, for overlapping plots such as an apartment block. |
GetCurrentProperty() | The plot the player is standing on right now, or nil. |
IsOnProperty(houseId) | Whether the player stands on the property of that house. |
GetHouseZone(houseId) | The stored border shape of a house. |
GetAccent() | The accent colour the player picked in Housing > Settings. |
GetAppUrl(theme) | The address of the Housing app page, to add the app to any other phone. Pass 'light' or 'dark' to force a theme. |
GetAppData() | Everything the Housing app shows: the homes the player owns, rents or holds a key to. |
AppAction(action, houseId) | Runs an app action for a house: 'waypoint', 'lock' or 'cams'. |
02Server Exports
| Export | Description |
|---|---|
GetHouses() | Every house on the server, keyed by id. |
GetPlayerHouses(source) | The houses that player owns. |
HasHouseAccess(source, houseId) | Whether that player owns the house or holds a key to it. |
GetHouseAtPoint(coords) | The first house whose property border owns this ground. |
GetHousesAtPoint(coords) | Every house owning this ground, for overlapping plots. |
GetHouseZone(houseId) | The stored border shape of a house. |
03Events
| Name | Side | Description |
|---|---|---|
agency-housing:client:enteredZone | Client | Fires with (houseId, house) when the player steps onto a property, so a job or robbery script does not have to poll. |
agency-housing:client:leftZone | Client | Fires with (houseId, house) when the player leaves a property. |
agency-housing:garage:open | Client | Fires with (houseId, houseName) when a house garage is used and Config.Garage.script is 'event', so your own garage script can open it. |