Exports

With these exports, you will be able to manipulate the system from scripts external to it.

Client Exports

InsideHouse

exports['origen_housing']:insideHouse()

Check if a player is inside a house, return true if inside or false if not inside.

Example:

local inside = exports['origen_housing']:insideHouse()
if inside then
    print("Player is inside a house.")
else
    print("Player is not inside a house.")
end

GetHouses

exports['origen_housing']:getHouses()

Returns all server houses as a client request.

Example:

local houses = exports['origen_housing']:getHouses()
for , house in ipairs(houses) do
    print(house.name)
end

GetPlayerHouses

-- @param identifier (string): The identifier of the character.
-- If empty, it will take the client identifier.
exports['origen_housing']:getPlayerHouses(identifier)

Returns a table with house data or an empty table if there are no houses.

IsBusy

exports['origen_housing']:isBusy()

Returns if the player is busy using menus or creating a house.

Example:

local busy = exports['origen_housing']:isBusy()
if busy then
    print("Player is busy.")
else
    print("Player is not busy.")
end

OpenHouseMenu

exports['origen_housing']:OpenHouseMenu()

Export to open the house management menu

CloseHouseMenu

exports['origen_housing']:CloseHouseMenu()

Esport to close the house management menu

Server Exports

GetAllHouses

exports['origen_housing']:getAllHouses()

Returns all server houses as a server request.

Example:

local houses = exports['origen_housing']:getAllHouses()
for _, house in ipairs(houses) do
    print(house.name)
end

GetHouse

-- @param houseID (int): The ID of the house.
exports['origen_housing']:getHouse(houseID)

Returns a specific house using the ID of the house.

Example:

local houseID = 1
local house = exports['origen_housing']:getHouse(houseID)

if house then 
    print(house.name)
else
    print('The house id is not valid')
end

GetOwnedHouses

-- @param identifier (string): The identifier of the character.
exports['origen_housing']:getOwnedHouses(identifier)

Returns all houses of a certain character using their identifier.

Example:

local identifier = 'AB12345'
local ownedHouses = exports['origen_housing']:getOwnedHouses(identifier)
for _, houseID in ipairs(ownedHouses) do
    local house = exports['origen_housing']:getHouse(houseID)
    
    if house then 
       print(house.name) 
    end
end

SetHouseOwner

-- @param houseID (int): The identifier of the house.
-- @param source (int): The player source
exports['origen_housing']:setHouseOwner(houseID, source)

Establishes the player as the owner of the house.

Example:

local houseID = 1
local success = exports['origen_housing']:setHouseOwner(houseID, source)

if success then
    print('House ownership assigned successfully.')
else
    print('Failed to assign house ownership.')
end

RegisterHook

-- @param eventName (string): Name of hook event
-- @param options (table): Table of hook options
exports.origen_housing:registerHook(eventName, function(payload)
end, options)

Examples of use

RemoveHooks

-- @param id (int): Hook id
exports.origen_housing:removeHooks(id)

Examples of use