Metatable:House

No description available at the moment.

Available methods:

getAccessList(listId)
getBedCount()
getBeds()
getDoorCount()
getDoors()
getExitPosition()
getId()
getItems()
getName()
getOwnerGuid()
getOwnerGuild()
getRent()
getTileCount()
getTiles()
getTown()
getType()
setAccessList(listId, list)
setOwnerGuid(guid, updateDatabase = true)

---

getAccessList(listId)

Description: N/A
Parameters:

• listId - No description

Returns: N/A
Example:

local house = House(...)
house:getAccessList(GUEST_LIST)

Added in version: 1.0

---

getBedCount()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getBedCount()

Added in version: 1.0

---

getBeds()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getBeds()

Added in version: 1.0

---

getDoorCount()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getDoorCount()

Added in version: 1.0

---

getDoors()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getDoors()

Added in version: 1.0

---

getExitPosition()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getExitPosition()

Added in version: 1.0

---

getId()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getId()

Added in version: 1.0

---

getItems

getItems()

Description: N/A
Parameters: None
Returns: a table with the items that are in that house Example:

local house = House(...)
house:getItems()

Added in version: 1.3

---

getName()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getName()

Added in version: 1.0

---

getOwnerGuid()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getOwnerGuid()

Added in version: 1.0

---

getOwnerGuild()

Description: Return the guild_id of the house if it is a guildhall
Parameters: None
Returns: guild_id
Example:

local house = House(...)
if house:getType() == HOUSE_TYPE_GUILDHALL then
    house:getOwnerGuild()
end

Added in version: 1.4 #2214

---

getRent()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getRent()

Added in version: 1.0

---

getTileCount()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getTileCount()

Added in version: 1.0

---

getTiles()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getTiles()

Added in version: 1.0

---

getTown()

Description: N/A
Parameters: None
Returns: N/A
Example:

local house = House(...)
house:getTown()

Added in version: 1.0

---

getType()

Description: Retrieve house type.
Parameters: None
Returns: Enum HouseType (HOUSE_TYPE_NORMAL, HOUSE_TYPE_GUILDHALL)
Example:

local house = House(...)
if house:getType() == HOUSE_TYPE_GUILDHALL then
    -- ...
end

Added in version: 1.4 #2214

---

setAccessList(listId, list)

Description: N/A
Parameters:

• listId - No description
• list - No description

Returns: N/A
Example:

local house = House(...)
house:setAccessList(GUEST_LIST, house_name_list)

Added in version: 1.0

---

setOwnerGuid(guid[, updateDatabase = true])

Description: N/A
Parameters:

• guid - No description
• updateDatabase - (optional, default: true)

Returns: N/A
Example:

local house = House(...)
house:setOwnerGuid(unknown, true)

[To the top] Added in version: 1.0