X2House

Globals

DEMOLISH_EMPTY_ITEM_TYPE

integer

HOUSE_ALLOW_ALL

integer

HOUSE_ALLOW_ALLIANCE

integer

HOUSE_ALLOW_EXPEDITION

integer

HOUSE_ALLOW_FAMILY

integer

HOUSE_ALLOW_FAMILY_AND_EXPEDITION

integer

HOUSE_ALLOW_OWNER

integer

HOUSING_TAX_CONTRIBUTION

integer

HOUSING_TAX_SEAL

integer

HOUSING_UCC_POS_FLOOR

integer

HOUSING_UCC_POS_ROOF

integer

HOUSING_UCC_POS_TOP

integer

HOUSING_UCC_POS_WALL

integer

HOUSING_UCC_POS_WALL_OUTDOOR

integer

MAX_PREPAID_WEEKS

integer

X2House

X2House

Aliases

HOUSE_ALLOW

HOUSE_ALLOW_ALLIANCE|HOUSE_ALLOW_ALL|HOUSE_ALLOW_EXPEDITION|HOUSE_ALLOW_FAMILY_AND_EXPEDITION|HOUSE_ALLOW_FAMILY…(+1)

-- api/X2House
HOUSE_ALLOW:
    | `HOUSE_ALLOW_ALL`
    | `HOUSE_ALLOW_ALLIANCE`
    | `HOUSE_ALLOW_EXPEDITION`
    | `HOUSE_ALLOW_FAMILY`
    | `HOUSE_ALLOW_FAMILY_AND_EXPEDITION`
    | `HOUSE_ALLOW_OWNER`

HOUSING_TAX

HOUSING_TAX_CONTRIBUTION|HOUSING_TAX_SEAL

HOUSING_TAX:
    | `HOUSING_TAX_CONTRIBUTION`
    | `HOUSING_TAX_SEAL`

HOUSING_UCC_POS_TYPE

HOUSING_UCC_POS_FLOOR|HOUSING_UCC_POS_ROOF|HOUSING_UCC_POS_TOP|HOUSING_UCC_POS_WALL_OUTDOOR|HOUSING_UCC_POS_WALL

-- api/X2House
HOUSING_UCC_POS_TYPE:
    | `HOUSING_UCC_POS_FLOOR`
    | `HOUSING_UCC_POS_ROOF`
    | `HOUSING_UCC_POS_TOP`
    | `HOUSING_UCC_POS_WALL`
    | `HOUSING_UCC_POS_WALL_OUTDOOR`

Classes

Class: X2House

Method: GetCurrentHousingTaxInfo

(method) X2House:GetCurrentHousingTaxInfo()
  -> currentHousingTaxInfo: HousingTaxInfo|nil

Retrieves the housing tax information of the current house when the building information window is open. See: HousingTaxInfo

Method: GetHouseOwnerName

(method) X2House:GetHouseOwnerName()
  -> houseOwnerName: string

Retrieves the house owner name of the current house when the building information window is open.

@return houseOwnerName — The house owners name.

Method: GetHouseName

(method) X2House:GetHouseName()
  -> houseName: string

Retrieves the house name of the current house when the building information window is open.

@return houseName — The house name.

Method: GetHouseType

(method) X2House:GetHouseType()
  -> houseType: number

Retrieves the house type (id) of the current house when the building information window is open.

@return houseType — The type for the house.