Início › Documentação › Exports · origen_housing

Exports · origen_housing

Todos os exports estão registados com o nome de recurso origen_housing.

Exports do servidor

getAllHouses() → table

Devolve todas as casas da base de dados.

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

getOwnedHouses(identifier) → table

Devolve todas as casas que pertencem a um jogador.

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

getHouse(id) → table | nil

Devolve os dados da casa com o ID indicado.

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

setHouseOwner(id, source)

Define como proprietário de uma casa o jogador indicado (source = ID de servidor).

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

hasKey(_, citizenid, houseID) → boolean

Verifica se um jogador tem chave de uma casa.

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

lockpick(source, isAdvanced)

Dispara a ação de gazua sobre uma casa para um jogador.

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

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

Gere por código as portas de uma casa.

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

Abre uma porta, guarda o seu estado ou ativa o alarme da casa.

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

Compra uma melhoria para uma casa.

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

Gere os móveis de uma casa.

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

Gere luzes e quadros, e consulta as respetivas quantidades.

saveBuilding(houseID, stage) / startBuilding(houseID)

Controla a fase de construção de uma casa.

registerHook(event, cb, options) → id

Regista um hook do lado do servidor sobre eventos das casas. Devolve um 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 disponíveis: onBuyHouse, onDeleteHouse, onBuyUpgrade, onBuyFurniture, onDeleteFurniture.

removeHooks(id)

Remove um hook registado anteriormente.

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

AddTableData(table, columns) / checkTables()

Utilitários para a gestão dinâmica do esquema da base de dados. Usados internamente.

Exports do cliente

insideHouse() → number | nil

Devolve o ID da casa em que o jogador local se encontra, ou nil se estiver fora.

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

getNearbyHouse() → table | nil

Devolve os dados da casa mais próxima da posição atual do jogador.

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

getPlayerHouses() → table[]

Devolve as casas que pertencem ao jogador local. Cada entrada contém label, location, desc, entryCoords.

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

getHouses() → table

Devolve todas as casas carregadas no cliente.

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

OpenHouseMenu() / CloseHouseMenu()

Abre ou fecha por código o painel de gestão dentro da casa.

setHousePosition(houseID)

Teletransporta o jogador para o ponto de entrada de uma casa.

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

toggleDoor(houseID)

Alterna a porta principal de uma casa (trancar/destrancar).

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

getHouseDoor(houseID) → table | nil

Devolve os dados da porta principal de uma casa.

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

Adiciona ou remove um detentor de chave de uma casa.

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

loadHouse(houseID, cb, options)

Carrega uma casa manualmente e chama cb quando termina.

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

isBusy() → boolean

Devolve true se o sistema de casas estiver a processar uma ação nesse momento (p. ex. a entrar ou a sair).

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