Client Exports V2
Use these exports to integrate it to your scripts! Feel free to reach me to have your scripts to be put into integrations.
GetOwnedHomes​
This export will return the owned homes of the player.
exports.bcs_housing:GetOwnedHomes()
Returned Data (Object)​
Key | Data Type | Description |
---|---|---|
identifier | string | The home identifier |
name | string | The home name / label |
type | 'mlo' or 'shell' or 'ipl' | The home type |
price | number | The home price |
garage | Object (x, y, z) | The coordinate of the garage (if there is any) |
entry | Object (x,y,z) | The coordinate of the entrance |
locked | boolean | Status of the house lock for SHELL |
LockHome​
Export this function to lock the home based on the identifier
exports.bcs_housing:LockHome(identifier)
Parameter​
identifier
it accepts thehouse
identifier
isLocked​
Export this function to get the status of the house (Shell) lock
-- returned data is boolean (true/false)
exports.bcs_housing:isLocked(identifier)
Parameter​
identifier
thehouse
identifier
GiveKey​
Export this function to give a key to a target (Server Id) with the house ID
exports.bcs_housing:GiveKey(identifier, GetPlayerServerId(targetPed))
Parameter​
identifier
it accepts thehouse
identifiersource
the player server id
RemoveKey​
Export this function to remove a key to a target (Server Id / Player Identifier) with the house ID
exports.bcs_housing:RemoveKey(identifier, TargetIdentifier)
Parameter​
identifier
it accepts thehouse
identifierTargetIdentifier
it accepts the player identifier,citizenid
for QB
HasKey​
Export this function to check if player has key with the house ID
exports.bcs_housing:HasKey(identifier) -- home identifier
Parameter​
identifier
it accepts thehouse
identifier
GetKeyHolders​
This export will return the key holders of a home.
exports.bcs_housing:GetKeyHolders(identifier) -- home identifier
Parameter​
identifier
it accepts thehouse
identifier
Returned Data (Array of Objects)​
Key | Data Type | Description |
---|---|---|
identifier | string | The player identifier |
name | string | The player name |
SetWaypoint​
Export this function to set your waypoint to the entrance of the home
exports.bcs_housing:SetWaypoint(identifier) -- home identifier