Inicio › Documentación › Exports · origen_housing

Exports · origen_housing

Todos los exports están registrados con el nombre de recurso origen_housing.

Exports del servidor

getAllHouses() → table

Devuelve todas las casas de la base de datos.

lua
local houses = exports['origen_housing']:getAllHouses()

getOwnedHouses(identifier) → table

Devuelve todas las casas que pertenecen a un jugador.

lua
local houses = exports['origen_housing']:getOwnedHouses(citizenid)

getHouse(id) → table | nil

Devuelve los datos de la casa con el ID indicado.

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

setHouseOwner(id, source)

Establece como propietario de una casa al jugador indicado (source = ID de servidor).

lua
exports['origen_housing']:setHouseOwner(houseID, source)

hasKey(_, citizenid, houseID) → boolean

Comprueba si un jugador tiene llave de una casa.

lua
local hasKey = exports['origen_housing']:hasKey(nil, citizenid, houseID)

lockpick(source, isAdvanced)

Lanza la acción de ganzúa sobre una casa para un jugador.

lua
exports['origen_housing']:lockpick(source, false)

createDoor(houseID, data) / deleteDoor(houseID, doorID) / updateDoorState(houseID, doorID, state)

Gestiona por código las puertas de una casa.

openDoor(houseID, doorID) / saveDoorStatus(houseID) / startAlarm(houseID)

Abre una puerta, guarda su estado o activa la alarma de la casa.

buyUpgrade(source, houseID, upgrade) / buyHouseUpgrade(source, houseID, upgrade)

Compra una mejora para una casa.

buyFurniture(source, houseID, data) / updateFurniture(...) / deleteFurniture(...)

Gestiona los muebles de una casa.

updateLight(...) / updateBoard(...) / getLightCount(houseID) / getStashesCount(houseID)

Gestiona luces y tableros, y consulta sus cantidades.

saveBuilding(houseID, stage) / startBuilding(houseID)

Controla la fase de construcción de una casa.

registerHook(event, cb, options) → id

Registra un hook del lado servidor sobre eventos de las casas. Devuelve un ID de hook.

lua
local id = exports['origen_housing']:registerHook('onBuyHouse', function(payload, cancel)
    -- payload: { source, houseID, price, owner }
    -- cancel() to abort the action
end)

Eventos disponibles: onBuyHouse, onDeleteHouse, onBuyUpgrade, onBuyFurniture, onDeleteFurniture.

removeHooks(id)

Elimina un hook registrado anteriormente.

lua
exports['origen_housing']:removeHooks(id)

AddTableData(table, columns) / checkTables()

Utilidades para la gestión dinámica del esquema de la base de datos. Se usan internamente.

Exports del cliente

insideHouse() → number | nil

Devuelve el ID de la casa en la que se encuentra el jugador local, o nil si está fuera.

lua
local houseID = exports['origen_housing']:insideHouse()

getNearbyHouse() → table | nil

Devuelve los datos de la casa más cercana a la posición actual del jugador.

lua
local house = exports['origen_housing']:getNearbyHouse()

getPlayerHouses() → table[]

Devuelve las casas que pertenecen al jugador local. Cada entrada contiene label, location, desc, entryCoords.

lua
local houses = exports['origen_housing']:getPlayerHouses()

getHouses() → table

Devuelve todas las casas cargadas en el cliente.

lua
local houses = exports['origen_housing']:getHouses()

OpenHouseMenu() / CloseHouseMenu()

Abre o cierra por código el panel de gestión dentro de la casa.

setHousePosition(houseID)

Teletransporta al jugador al punto de entrada de una casa.

lua
exports['origen_housing']:setHousePosition(houseID)

toggleDoor(houseID)

Alterna la puerta principal de una casa (bloquear/desbloquear).

lua
exports['origen_housing']:toggleDoor(houseID)

getHouseDoor(houseID) → table | nil

Devuelve los datos de la puerta principal de una casa.

addKeyHolder(houseID, target) / removeKeyHolder(houseID, identifier)

Añade o quita a un poseedor de llave de una casa.

lua
exports['origen_housing']:addKeyHolder(houseID, targetServerId)
exports['origen_housing']:removeKeyHolder(houseID, citizenid)

loadHouse(houseID, cb, options)

Carga una casa manualmente y llama a cb al terminar.

lua
exports['origen_housing']:loadHouse(houseID, function()
    print('House loaded')
end, {})

isBusy() → boolean

Devuelve true si el sistema de casas está procesando una acción en ese momento (p. ej. entrar o salir).

lua
if exports['origen_housing']:isBusy() then return end