Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

X2Resident

Globals

HOUSING_LIST_FILTER_ALL

integer

HOUSING_LIST_FILTER_FARM

integer

HOUSING_LIST_FILTER_FLOATING

integer

HOUSING_LIST_FILTER_HOUSE_NAME

integer

HOUSING_LIST_FILTER_LARGE

integer

HOUSING_LIST_FILTER_MANSION

integer

HOUSING_LIST_FILTER_MEDIUM

integer

HOUSING_LIST_FILTER_PUBLIC

integer

HOUSING_LIST_FILTER_SELLER_NAME

integer

HOUSING_LIST_FILTER_SMALL

integer

HOUSING_LIST_FILTER_UNDERWATER_STRUCTURE

integer

HOUSING_LIST_FILTER_WORKTABLE

integer

X2Resident

X2Resident

Aliases

HOUSING_LIST_FILTER

HOUSING_LIST_FILTER_ALL|HOUSING_LIST_FILTER_FARM|HOUSING_LIST_FILTER_FLOATING|HOUSING_LIST_FILTER_HOUSE_NAME|HOUSING_LIST_FILTER_LARGE…(+7)

-- api/X2Resident
HOUSING_LIST_FILTER:
    | `HOUSING_LIST_FILTER_ALL`
    | `HOUSING_LIST_FILTER_FARM`
    | `HOUSING_LIST_FILTER_FLOATING`
    | `HOUSING_LIST_FILTER_HOUSE_NAME`
    | `HOUSING_LIST_FILTER_LARGE`
    | `HOUSING_LIST_FILTER_MANSION`
    | `HOUSING_LIST_FILTER_MEDIUM`
    | `HOUSING_LIST_FILTER_PUBLIC`
    | `HOUSING_LIST_FILTER_SELLER_NAME`
    | `HOUSING_LIST_FILTER_SMALL`
    | `HOUSING_LIST_FILTER_UNDERWATER_STRUCTURE`
    | `HOUSING_LIST_FILTER_WORKTABLE`

Classes

Class: X2Resident

Method: FilterHousingTradeList

(method) X2Resident:FilterHousingTradeList(filterindex: `HOUSING_LIST_FILTER_ALL`|`HOUSING_LIST_FILTER_FARM`|`HOUSING_LIST_FILTER_FLOATING`|`HOUSING_LIST_FILTER_HOUSE_NAME`|`HOUSING_LIST_FILTER_LARGE`...(+7), searchWord: string)
  -> unknown: boolean

Searches for housing trade listings in the current zone with the given filter and search word, triggering the RESIDENT_HOUSING_TRADE_LIST event.

@param filterindex — The filter to apply.

@param searchWord — The search term.

-- api/X2Resident
filterindex:
    | `HOUSING_LIST_FILTER_ALL`
    | `HOUSING_LIST_FILTER_FARM`
    | `HOUSING_LIST_FILTER_FLOATING`
    | `HOUSING_LIST_FILTER_HOUSE_NAME`
    | `HOUSING_LIST_FILTER_LARGE`
    | `HOUSING_LIST_FILTER_MANSION`
    | `HOUSING_LIST_FILTER_MEDIUM`
    | `HOUSING_LIST_FILTER_PUBLIC`
    | `HOUSING_LIST_FILTER_SELLER_NAME`
    | `HOUSING_LIST_FILTER_SMALL`
    | `HOUSING_LIST_FILTER_UNDERWATER_STRUCTURE`
    | `HOUSING_LIST_FILTER_WORKTABLE`

Method: RefreshResidentMembers

(method) X2Resident:RefreshResidentMembers(zoneGroupType: `0`|`100`|`101`|`102`|`103`...(+151), offline: boolean, startIndex: number)

Refreshes the list of members shown on the resident board. The resident board must be open for the refresh to take effect.

@param zoneGroupType — The zone group ID of the residence.

@param offline — true to include offline characters, false to show online only.

@param startIndex — The starting index of the list. (min: 1)

-- Obtained from db zone_groups
zoneGroupType:
    | `0` -- current - Current location
    | `1` -- w_gweonid_forest - Gweonid Forest
    | `2` -- w_marianople - Marianople
    | `3` -- w_garangdol_plains - Dewstone Plains
    | `4` -- e_sunrise_peninsula - Solis Headlands
    | `5` -- w_solzreed - Solzreed Peninsula
    | `6` -- w_lilyut_meadow - Lilyut Hills
    | `7` -- e_rainbow_field - Arcum Iris
    | `8` -- w_two_crowns - Two Crowns
    | `9` -- e_mahadevi - Mahadevi
    | `10` -- w_bronze_rock - Airain Rock
    | `11` -- e_falcony_plateau - Falcorth Plains
    | `12` -- e_singing_land - Villanelle
    | `13` -- e_sunny_wilderness - Sunbite Wilds
    | `14` -- e_steppe_belt - Windscour Savannah
    | `15` -- e_ruins_of_hariharalaya - Perinoor Ruins
    | `16` -- e_lokas_checkers - Rookborne Basin
    | `17` -- e_ynystere - Ynystere
    | `18` -- w_white_forest - White Arden
    | `19` -- w_the_carcass - Karkasse Ridgelands
    | `20` -- w_cross_plains - Cinderstone Moor
    | `21` -- w_cradle_of_genesis - Aubre Cradle
    | `22` -- w_golden_plains - Halcyona
    | `23` -- e_hasla - Hasla
    | `24` -- e_tiger_spine_mountains - Tigerspine Mountains
    | `25` -- e_ancient_forest - Silent Forest
    | `26` -- w_hell_swamp - Hellswamp
    | `27` -- w_long_sand - Sanddeep
    | `28` -- w_barren_land - The Wastes
    | `29` -- s_lost_island - Libertia Sea
    | `30` -- s_lostway_sea - Castaway Strait
    | `31` -- instance_training_camp - Drill Camp
    | `32` -- instance_silent_colossus - Dreadnought
    | `33` -- o_salpimari - Heedmar
    | `34` -- o_nuimari - Nuimari
    | `35` -- w_dark_side_of_the_moon -
    | `36` -- s_silent_sea - Arcadian Sea
    | `37` -- e_una_basin -
    | `38` -- s_nightmare_coast -
    | `39` -- s_golden_sea - Halcyona Gulf
    | `40` -- s_crescent_sea - Feuille Sound
    | `41` -- locked_sea_temp - Forbidden Sea
    | `42` -- locked_land_temp - Forbidden Shore
    | `43` -- o_seonyeokmari - Marcala
    | `44` -- o_rest_land - Calmlands
    | `45` -- instance_burntcastle_armory - Burnt Castle Armory
    | `46` -- instance_hadir_farm - Hadir Farm
    | `47` -- instance_sal_temple - Palace Cellar
    | `48` -- e_white_island - Saltswept Atoll
    | `49` -- arche_mall - Mirage Isle
    | `50` -- instance_cuttingwind_deadmine - Sharpwind Mines
    | `51` -- instance_howling_abyss - Howling Abyss
    | `52` -- instance_cradle_of_destruction - Kroloal Cradle
    | `53` -- test_instance_violent_maelstrom - Violent Maelstrom Arena
    | `54` -- o_abyss_gate - Exeloch
    | `55` -- instance_nachashgar - Serpentis
    | `56` -- o_land_of_sunlights - Sungold Fields
    | `57` -- o_ruins_of_gold - Golden Ruins
    | `58` -- instance_howling_abyss_2 - Greater Howling Abyss
    | `59` -- s_freedom_island - Sunspeck Sea
    | `60` -- s_pirate_island - Stormraw Sound
    | `61` -- o_shining_shore - Diamond Shores
    | `62` -- instance_immortal_isle - Sea of Drowned Love
    | `63` -- o_the_great_reeds - Reedwind
    | `64` -- instance_immortal_isle_easy - Lesser Sea of Drowned Love
    | `65` -- o_library_2 - Verdant Skychamber
    | `66` -- instance_nachashgar_easy - Lesser Serpentis
    | `67` -- o_library_1 - Introspect Path
    | `68` -- instance_prologue - Lucius's Dream
    | `69` -- o_library_3 - Evening Botanica
    | `70` -- instance_library_1 - Encyclopedia Room
    | `71` -- instance_library_2 - Libris Garden
    | `72` -- instance_library_3 - Screaming Archives
    | `73` -- instance_library_boss_1 - Screening Hall
    | `74` -- instance_library_boss_2 - Frozen Study
    | `75` -- instance_library_boss_3 - Deranged Bookroom
    | `76` -- instance_library_tower_defense - Corner Reading Room
    | `77` -- instance_training_camp_1on1 - Gladiator Arena
    | `78` -- o_dew_plains - Mistmerrow
    | `79` -- w_mirror_kingdom - Miroir Tundra
    | `80` -- s_broken_mirrors_sea - Shattered Sea
    | `81` -- instance_battle_field - New Arena
    | `82` -- o_epherium - Epherium
    | `83` -- instance_hadir_farm_hard - Greater Hadir Farm
    | `84` -- instance_burntcastle_armory_hard - Greater Burnt Castle Armory
    | `85` -- instance_library_heart - Heart of Ayanad
    | `86` -- instance_sal_temple_hard - Greater Palace Cellar
    | `87` -- instance_cuttingwind_deadmine_hard - Greater Sharpwind Mines
    | `88` -- instance_cradle_of_destruction_hard - Greater Kroloal Cradle
    | `89` -- instance_feast_garden - Mistsong Summit
    | `90` -- instance_training_camp_no_item - Arena
    | `91` -- instance_the_judge_of_uthstin - Decisive Arena
    | `92` -- instance_battle_field_of_feast - Free-For-All Arena
    | `93` -- w_hanuimaru - Ahnimar
    | `94` -- instance_prologue_izuna - Ancient Ezna
    | `95` -- s_boiling_sea - Boiling Sea
    | `96` -- e_sylvina_region - Sylvina Caldera
    | `97` -- instance_sea_of_chaos - Bloodsalt Bay
    | `98` -- o_room_of_queen - Queen's Chamber
    | `99` -- e_lokaloka_mountains - Rokhala Mountains
    | `100` -- o_room_of_queen_2 - Queen's Chamber
    | `101` -- o_room_of_queen_3 - Burnt Castle Cellar
    | `102` -- o_candlestick_of_sea - Aegis Island
    | `103` -- o_whale_song_bay - Whalesong Harbor
    | `104` -- s_whale_swell_strait - Whaleswell Straits
    | `105` -- instance_hanging_gardens_of_ipna - Ipnysh Sanctuary
    | `106` -- instance_festival_training_camp_1on1 - Snowball Arena
    | `107` -- o_hirama_the_west - Western Hiram Mountains
    | `108` -- instance_golden_plains - Golden Plains Battle
    | `109` -- instance_golden_plains_war - Golden Plains Battle
    | `110` -- o_hirama_the_east - Eastern Hiram Mountains
    | `111` -- instance_library_new_boss_1 - Screening Hall (Disabled)
    | `112` -- instance_library_new_boss_2 - Frozen Study (Disabled)
    | `113` -- instance_library_new_boss_3 - Deranged Bookroom (Disabled)
    | `114` -- test_arcaneearth - Corner Reading Room (Disabled)
    | `115` -- instance_library_new_heart - Heart of Ayanad (Disabled)
    | `116` -- library_lobby_1f - Unused
    | `117` -- library_lobby_2f - Verdant Skychamber (Disabled)
    | `118` -- library_lobby_3f - Evening Botanica (Disabled)
    | `119` -- library_lobby_4f - Constellation Breakroom (Disabled)
    | `120` -- instance_library_boss_total - Abyssal Library
    | `121` -- instance_carcass - Red Dragon's Keep
    | `122` -- instance_the_last_day_of_hiramakand - The Fall of Hiram City
    | `125` -- instance_challenge_tower - Noryette Challenge
    | `126` -- zonegroup_instance_defense_of_feast - Mistsong Banquet
    | `127` -- instance_sea_survival - Naval Survival Game (test)
    | `129` -- instance_sea_survival_2 - Stillwater Gulf
    | `130` -- instance_eternity - Hereafter Rebellion
    | `131` -- instance_dew_plain - Battle of Mistmerrow
    | `132` -- instance_dewplane_boss - Kadum
    | `133` -- the_garden - Garden of the Gods
    | `134` -- gatekeeper_hall - Gatekeeper Hall
    | `135` -- instance_hanuimaru_zone - Dairy Cow Dreamland
    | `136` -- instance_restraint_of_power - Circle of Authority
    | `137` -- instance_phantom_of_delphinad - Delphinad Mirage
    | `138` -- instance_arena_2on2 - Test Arena
    | `139` -- o_land_of_magic - Mysthrane Gorge
    | `140` -- o_mount_ipnir - Ipnya Ridge
    | `141` -- instance_garuda_nest - Skyfin War
    | `142` -- instance_mount_ipnir_story - Queen's Altar
    | `143` -- instance_event_camp_1on1 - Event Arena
    | `144` -- test_cbush - Guild House
    | `145` -- instance_black_thorn - Unused
    | `146` -- instance_black_spike - Black Thorn Prison
    | `147` -- o_western_prairie - Great Prairie of the West
    | `148` -- instance_nachashgar_ancient - Greater Serpentis
    | `149` -- instance_cuttlefish_event_zone - Squid Game Event Arena
    | `150` -- instance_dimensional_defence - Dimensional Boundary Defense Raid
    | `151` -- instance_event_hanuimaru - Ahnimar Event Arena
    | `152` -- w_golden_moss_forest - Goldleaf Forest
    | `153` -- instance_training_camp_1on1_ga - Make a Splash
    | `154` -- instance_burntcastle_armory_nightmare - Nightmare Burnt Castle Armory
    | `155` -- instance_divided_crossroad - Crossroads Arena
    | `156` -- instance_noryette_battlefield - Noryette Arena
    | `158` -- instance_life_dungeon_daru - Island of Abundance
    | `159` -- instance_golden_plains_ga - Golden Plains Battle

Method: GetResidentMembers

(method) X2Resident:GetResidentMembers(zoneGroupType: `0`|`100`|`101`|`102`|`103`...(+151), offline: boolean, startIndex: number)

Gets a list of resident members and displays them on the resident board. The resident board must be open for the list to appear.

@param zoneGroupType — The zone group ID of the residence.

@param offline — true to include offline characters, false to show online only.

@param startIndex — The starting index of the list. (min: 1)

-- Obtained from db zone_groups
zoneGroupType:
    | `0` -- current - Current location
    | `1` -- w_gweonid_forest - Gweonid Forest
    | `2` -- w_marianople - Marianople
    | `3` -- w_garangdol_plains - Dewstone Plains
    | `4` -- e_sunrise_peninsula - Solis Headlands
    | `5` -- w_solzreed - Solzreed Peninsula
    | `6` -- w_lilyut_meadow - Lilyut Hills
    | `7` -- e_rainbow_field - Arcum Iris
    | `8` -- w_two_crowns - Two Crowns
    | `9` -- e_mahadevi - Mahadevi
    | `10` -- w_bronze_rock - Airain Rock
    | `11` -- e_falcony_plateau - Falcorth Plains
    | `12` -- e_singing_land - Villanelle
    | `13` -- e_sunny_wilderness - Sunbite Wilds
    | `14` -- e_steppe_belt - Windscour Savannah
    | `15` -- e_ruins_of_hariharalaya - Perinoor Ruins
    | `16` -- e_lokas_checkers - Rookborne Basin
    | `17` -- e_ynystere - Ynystere
    | `18` -- w_white_forest - White Arden
    | `19` -- w_the_carcass - Karkasse Ridgelands
    | `20` -- w_cross_plains - Cinderstone Moor
    | `21` -- w_cradle_of_genesis - Aubre Cradle
    | `22` -- w_golden_plains - Halcyona
    | `23` -- e_hasla - Hasla
    | `24` -- e_tiger_spine_mountains - Tigerspine Mountains
    | `25` -- e_ancient_forest - Silent Forest
    | `26` -- w_hell_swamp - Hellswamp
    | `27` -- w_long_sand - Sanddeep
    | `28` -- w_barren_land - The Wastes
    | `29` -- s_lost_island - Libertia Sea
    | `30` -- s_lostway_sea - Castaway Strait
    | `31` -- instance_training_camp - Drill Camp
    | `32` -- instance_silent_colossus - Dreadnought
    | `33` -- o_salpimari - Heedmar
    | `34` -- o_nuimari - Nuimari
    | `35` -- w_dark_side_of_the_moon -
    | `36` -- s_silent_sea - Arcadian Sea
    | `37` -- e_una_basin -
    | `38` -- s_nightmare_coast -
    | `39` -- s_golden_sea - Halcyona Gulf
    | `40` -- s_crescent_sea - Feuille Sound
    | `41` -- locked_sea_temp - Forbidden Sea
    | `42` -- locked_land_temp - Forbidden Shore
    | `43` -- o_seonyeokmari - Marcala
    | `44` -- o_rest_land - Calmlands
    | `45` -- instance_burntcastle_armory - Burnt Castle Armory
    | `46` -- instance_hadir_farm - Hadir Farm
    | `47` -- instance_sal_temple - Palace Cellar
    | `48` -- e_white_island - Saltswept Atoll
    | `49` -- arche_mall - Mirage Isle
    | `50` -- instance_cuttingwind_deadmine - Sharpwind Mines
    | `51` -- instance_howling_abyss - Howling Abyss
    | `52` -- instance_cradle_of_destruction - Kroloal Cradle
    | `53` -- test_instance_violent_maelstrom - Violent Maelstrom Arena
    | `54` -- o_abyss_gate - Exeloch
    | `55` -- instance_nachashgar - Serpentis
    | `56` -- o_land_of_sunlights - Sungold Fields
    | `57` -- o_ruins_of_gold - Golden Ruins
    | `58` -- instance_howling_abyss_2 - Greater Howling Abyss
    | `59` -- s_freedom_island - Sunspeck Sea
    | `60` -- s_pirate_island - Stormraw Sound
    | `61` -- o_shining_shore - Diamond Shores
    | `62` -- instance_immortal_isle - Sea of Drowned Love
    | `63` -- o_the_great_reeds - Reedwind
    | `64` -- instance_immortal_isle_easy - Lesser Sea of Drowned Love
    | `65` -- o_library_2 - Verdant Skychamber
    | `66` -- instance_nachashgar_easy - Lesser Serpentis
    | `67` -- o_library_1 - Introspect Path
    | `68` -- instance_prologue - Lucius's Dream
    | `69` -- o_library_3 - Evening Botanica
    | `70` -- instance_library_1 - Encyclopedia Room
    | `71` -- instance_library_2 - Libris Garden
    | `72` -- instance_library_3 - Screaming Archives
    | `73` -- instance_library_boss_1 - Screening Hall
    | `74` -- instance_library_boss_2 - Frozen Study
    | `75` -- instance_library_boss_3 - Deranged Bookroom
    | `76` -- instance_library_tower_defense - Corner Reading Room
    | `77` -- instance_training_camp_1on1 - Gladiator Arena
    | `78` -- o_dew_plains - Mistmerrow
    | `79` -- w_mirror_kingdom - Miroir Tundra
    | `80` -- s_broken_mirrors_sea - Shattered Sea
    | `81` -- instance_battle_field - New Arena
    | `82` -- o_epherium - Epherium
    | `83` -- instance_hadir_farm_hard - Greater Hadir Farm
    | `84` -- instance_burntcastle_armory_hard - Greater Burnt Castle Armory
    | `85` -- instance_library_heart - Heart of Ayanad
    | `86` -- instance_sal_temple_hard - Greater Palace Cellar
    | `87` -- instance_cuttingwind_deadmine_hard - Greater Sharpwind Mines
    | `88` -- instance_cradle_of_destruction_hard - Greater Kroloal Cradle
    | `89` -- instance_feast_garden - Mistsong Summit
    | `90` -- instance_training_camp_no_item - Arena
    | `91` -- instance_the_judge_of_uthstin - Decisive Arena
    | `92` -- instance_battle_field_of_feast - Free-For-All Arena
    | `93` -- w_hanuimaru - Ahnimar
    | `94` -- instance_prologue_izuna - Ancient Ezna
    | `95` -- s_boiling_sea - Boiling Sea
    | `96` -- e_sylvina_region - Sylvina Caldera
    | `97` -- instance_sea_of_chaos - Bloodsalt Bay
    | `98` -- o_room_of_queen - Queen's Chamber
    | `99` -- e_lokaloka_mountains - Rokhala Mountains
    | `100` -- o_room_of_queen_2 - Queen's Chamber
    | `101` -- o_room_of_queen_3 - Burnt Castle Cellar
    | `102` -- o_candlestick_of_sea - Aegis Island
    | `103` -- o_whale_song_bay - Whalesong Harbor
    | `104` -- s_whale_swell_strait - Whaleswell Straits
    | `105` -- instance_hanging_gardens_of_ipna - Ipnysh Sanctuary
    | `106` -- instance_festival_training_camp_1on1 - Snowball Arena
    | `107` -- o_hirama_the_west - Western Hiram Mountains
    | `108` -- instance_golden_plains - Golden Plains Battle
    | `109` -- instance_golden_plains_war - Golden Plains Battle
    | `110` -- o_hirama_the_east - Eastern Hiram Mountains
    | `111` -- instance_library_new_boss_1 - Screening Hall (Disabled)
    | `112` -- instance_library_new_boss_2 - Frozen Study (Disabled)
    | `113` -- instance_library_new_boss_3 - Deranged Bookroom (Disabled)
    | `114` -- test_arcaneearth - Corner Reading Room (Disabled)
    | `115` -- instance_library_new_heart - Heart of Ayanad (Disabled)
    | `116` -- library_lobby_1f - Unused
    | `117` -- library_lobby_2f - Verdant Skychamber (Disabled)
    | `118` -- library_lobby_3f - Evening Botanica (Disabled)
    | `119` -- library_lobby_4f - Constellation Breakroom (Disabled)
    | `120` -- instance_library_boss_total - Abyssal Library
    | `121` -- instance_carcass - Red Dragon's Keep
    | `122` -- instance_the_last_day_of_hiramakand - The Fall of Hiram City
    | `125` -- instance_challenge_tower - Noryette Challenge
    | `126` -- zonegroup_instance_defense_of_feast - Mistsong Banquet
    | `127` -- instance_sea_survival - Naval Survival Game (test)
    | `129` -- instance_sea_survival_2 - Stillwater Gulf
    | `130` -- instance_eternity - Hereafter Rebellion
    | `131` -- instance_dew_plain - Battle of Mistmerrow
    | `132` -- instance_dewplane_boss - Kadum
    | `133` -- the_garden - Garden of the Gods
    | `134` -- gatekeeper_hall - Gatekeeper Hall
    | `135` -- instance_hanuimaru_zone - Dairy Cow Dreamland
    | `136` -- instance_restraint_of_power - Circle of Authority
    | `137` -- instance_phantom_of_delphinad - Delphinad Mirage
    | `138` -- instance_arena_2on2 - Test Arena
    | `139` -- o_land_of_magic - Mysthrane Gorge
    | `140` -- o_mount_ipnir - Ipnya Ridge
    | `141` -- instance_garuda_nest - Skyfin War
    | `142` -- instance_mount_ipnir_story - Queen's Altar
    | `143` -- instance_event_camp_1on1 - Event Arena
    | `144` -- test_cbush - Guild House
    | `145` -- instance_black_thorn - Unused
    | `146` -- instance_black_spike - Black Thorn Prison
    | `147` -- o_western_prairie - Great Prairie of the West
    | `148` -- instance_nachashgar_ancient - Greater Serpentis
    | `149` -- instance_cuttlefish_event_zone - Squid Game Event Arena
    | `150` -- instance_dimensional_defence - Dimensional Boundary Defense Raid
    | `151` -- instance_event_hanuimaru - Ahnimar Event Arena
    | `152` -- w_golden_moss_forest - Goldleaf Forest
    | `153` -- instance_training_camp_1on1_ga - Make a Splash
    | `154` -- instance_burntcastle_armory_nightmare - Nightmare Burnt Castle Armory
    | `155` -- instance_divided_crossroad - Crossroads Arena
    | `156` -- instance_noryette_battlefield - Noryette Arena
    | `158` -- instance_life_dungeon_daru - Island of Abundance
    | `159` -- instance_golden_plains_ga - Golden Plains Battle

Method: GetResidentBoardContent

(method) X2Resident:GetResidentBoardContent(boardType: `1`|`2`|`3`|`4`|`5`...(+2))
  -> residentBoardContent: ResidentBoardContent

Retrieves resident board content for the specified board type in the current zone.

@param boardType — The type of resident board.

@return residentBoardContent — The board content, or an empty table if not found.

boardType:
    | `1` -- Fabric   - Nuia/Haranya
    | `2` -- Leather  - Nuia/Haranya
    | `3` -- Lumber   - Nuia/Haranya
    | `4` -- Iron     - Nuia/Haranya
    | `5` -- Prince   - Auroria
    | `6` -- Queen    - Auroria
    | `7` -- Ancestor - Auroria

See: ResidentBoardContent

Method: RequestHousingTradeList

(method) X2Resident:RequestHousingTradeList(zoneGroupType: `0`|`100`|`101`|`102`|`103`...(+151), filterindex: `HOUSING_LIST_FILTER_ALL`|`HOUSING_LIST_FILTER_FARM`|`HOUSING_LIST_FILTER_FLOATING`|`HOUSING_LIST_FILTER_HOUSE_NAME`|`HOUSING_LIST_FILTER_LARGE`...(+7), searchWord: string)

Searches for housing trade listings in the specified zone with the given filter and search word, triggering the RESIDENT_HOUSING_TRADE_LIST event.

@param zoneGroupType — The zone ID to search.

@param filterindex — The filter to apply.

@param searchWord — The search term.

-- Obtained from db zone_groups
zoneGroupType:
    | `0` -- current - Current location
    | `1` -- w_gweonid_forest - Gweonid Forest
    | `2` -- w_marianople - Marianople
    | `3` -- w_garangdol_plains - Dewstone Plains
    | `4` -- e_sunrise_peninsula - Solis Headlands
    | `5` -- w_solzreed - Solzreed Peninsula
    | `6` -- w_lilyut_meadow - Lilyut Hills
    | `7` -- e_rainbow_field - Arcum Iris
    | `8` -- w_two_crowns - Two Crowns
    | `9` -- e_mahadevi - Mahadevi
    | `10` -- w_bronze_rock - Airain Rock
    | `11` -- e_falcony_plateau - Falcorth Plains
    | `12` -- e_singing_land - Villanelle
    | `13` -- e_sunny_wilderness - Sunbite Wilds
    | `14` -- e_steppe_belt - Windscour Savannah
    | `15` -- e_ruins_of_hariharalaya - Perinoor Ruins
    | `16` -- e_lokas_checkers - Rookborne Basin
    | `17` -- e_ynystere - Ynystere
    | `18` -- w_white_forest - White Arden
    | `19` -- w_the_carcass - Karkasse Ridgelands
    | `20` -- w_cross_plains - Cinderstone Moor
    | `21` -- w_cradle_of_genesis - Aubre Cradle
    | `22` -- w_golden_plains - Halcyona
    | `23` -- e_hasla - Hasla
    | `24` -- e_tiger_spine_mountains - Tigerspine Mountains
    | `25` -- e_ancient_forest - Silent Forest
    | `26` -- w_hell_swamp - Hellswamp
    | `27` -- w_long_sand - Sanddeep
    | `28` -- w_barren_land - The Wastes
    | `29` -- s_lost_island - Libertia Sea
    | `30` -- s_lostway_sea - Castaway Strait
    | `31` -- instance_training_camp - Drill Camp
    | `32` -- instance_silent_colossus - Dreadnought
    | `33` -- o_salpimari - Heedmar
    | `34` -- o_nuimari - Nuimari
    | `35` -- w_dark_side_of_the_moon -
    | `36` -- s_silent_sea - Arcadian Sea
    | `37` -- e_una_basin -
    | `38` -- s_nightmare_coast -
    | `39` -- s_golden_sea - Halcyona Gulf
    | `40` -- s_crescent_sea - Feuille Sound
    | `41` -- locked_sea_temp - Forbidden Sea
    | `42` -- locked_land_temp - Forbidden Shore
    | `43` -- o_seonyeokmari - Marcala
    | `44` -- o_rest_land - Calmlands
    | `45` -- instance_burntcastle_armory - Burnt Castle Armory
    | `46` -- instance_hadir_farm - Hadir Farm
    | `47` -- instance_sal_temple - Palace Cellar
    | `48` -- e_white_island - Saltswept Atoll
    | `49` -- arche_mall - Mirage Isle
    | `50` -- instance_cuttingwind_deadmine - Sharpwind Mines
    | `51` -- instance_howling_abyss - Howling Abyss
    | `52` -- instance_cradle_of_destruction - Kroloal Cradle
    | `53` -- test_instance_violent_maelstrom - Violent Maelstrom Arena
    | `54` -- o_abyss_gate - Exeloch
    | `55` -- instance_nachashgar - Serpentis
    | `56` -- o_land_of_sunlights - Sungold Fields
    | `57` -- o_ruins_of_gold - Golden Ruins
    | `58` -- instance_howling_abyss_2 - Greater Howling Abyss
    | `59` -- s_freedom_island - Sunspeck Sea
    | `60` -- s_pirate_island - Stormraw Sound
    | `61` -- o_shining_shore - Diamond Shores
    | `62` -- instance_immortal_isle - Sea of Drowned Love
    | `63` -- o_the_great_reeds - Reedwind
    | `64` -- instance_immortal_isle_easy - Lesser Sea of Drowned Love
    | `65` -- o_library_2 - Verdant Skychamber
    | `66` -- instance_nachashgar_easy - Lesser Serpentis
    | `67` -- o_library_1 - Introspect Path
    | `68` -- instance_prologue - Lucius's Dream
    | `69` -- o_library_3 - Evening Botanica
    | `70` -- instance_library_1 - Encyclopedia Room
    | `71` -- instance_library_2 - Libris Garden
    | `72` -- instance_library_3 - Screaming Archives
    | `73` -- instance_library_boss_1 - Screening Hall
    | `74` -- instance_library_boss_2 - Frozen Study
    | `75` -- instance_library_boss_3 - Deranged Bookroom
    | `76` -- instance_library_tower_defense - Corner Reading Room
    | `77` -- instance_training_camp_1on1 - Gladiator Arena
    | `78` -- o_dew_plains - Mistmerrow
    | `79` -- w_mirror_kingdom - Miroir Tundra
    | `80` -- s_broken_mirrors_sea - Shattered Sea
    | `81` -- instance_battle_field - New Arena
    | `82` -- o_epherium - Epherium
    | `83` -- instance_hadir_farm_hard - Greater Hadir Farm
    | `84` -- instance_burntcastle_armory_hard - Greater Burnt Castle Armory
    | `85` -- instance_library_heart - Heart of Ayanad
    | `86` -- instance_sal_temple_hard - Greater Palace Cellar
    | `87` -- instance_cuttingwind_deadmine_hard - Greater Sharpwind Mines
    | `88` -- instance_cradle_of_destruction_hard - Greater Kroloal Cradle
    | `89` -- instance_feast_garden - Mistsong Summit
    | `90` -- instance_training_camp_no_item - Arena
    | `91` -- instance_the_judge_of_uthstin - Decisive Arena
    | `92` -- instance_battle_field_of_feast - Free-For-All Arena
    | `93` -- w_hanuimaru - Ahnimar
    | `94` -- instance_prologue_izuna - Ancient Ezna
    | `95` -- s_boiling_sea - Boiling Sea
    | `96` -- e_sylvina_region - Sylvina Caldera
    | `97` -- instance_sea_of_chaos - Bloodsalt Bay
    | `98` -- o_room_of_queen - Queen's Chamber
    | `99` -- e_lokaloka_mountains - Rokhala Mountains
    | `100` -- o_room_of_queen_2 - Queen's Chamber
    | `101` -- o_room_of_queen_3 - Burnt Castle Cellar
    | `102` -- o_candlestick_of_sea - Aegis Island
    | `103` -- o_whale_song_bay - Whalesong Harbor
    | `104` -- s_whale_swell_strait - Whaleswell Straits
    | `105` -- instance_hanging_gardens_of_ipna - Ipnysh Sanctuary
    | `106` -- instance_festival_training_camp_1on1 - Snowball Arena
    | `107` -- o_hirama_the_west - Western Hiram Mountains
    | `108` -- instance_golden_plains - Golden Plains Battle
    | `109` -- instance_golden_plains_war - Golden Plains Battle
    | `110` -- o_hirama_the_east - Eastern Hiram Mountains
    | `111` -- instance_library_new_boss_1 - Screening Hall (Disabled)
    | `112` -- instance_library_new_boss_2 - Frozen Study (Disabled)
    | `113` -- instance_library_new_boss_3 - Deranged Bookroom (Disabled)
    | `114` -- test_arcaneearth - Corner Reading Room (Disabled)
    | `115` -- instance_library_new_heart - Heart of Ayanad (Disabled)
    | `116` -- library_lobby_1f - Unused
    | `117` -- library_lobby_2f - Verdant Skychamber (Disabled)
    | `118` -- library_lobby_3f - Evening Botanica (Disabled)
    | `119` -- library_lobby_4f - Constellation Breakroom (Disabled)
    | `120` -- instance_library_boss_total - Abyssal Library
    | `121` -- instance_carcass - Red Dragon's Keep
    | `122` -- instance_the_last_day_of_hiramakand - The Fall of Hiram City
    | `125` -- instance_challenge_tower - Noryette Challenge
    | `126` -- zonegroup_instance_defense_of_feast - Mistsong Banquet
    | `127` -- instance_sea_survival - Naval Survival Game (test)
    | `129` -- instance_sea_survival_2 - Stillwater Gulf
    | `130` -- instance_eternity - Hereafter Rebellion
    | `131` -- instance_dew_plain - Battle of Mistmerrow
    | `132` -- instance_dewplane_boss - Kadum
    | `133` -- the_garden - Garden of the Gods
    | `134` -- gatekeeper_hall - Gatekeeper Hall
    | `135` -- instance_hanuimaru_zone - Dairy Cow Dreamland
    | `136` -- instance_restraint_of_power - Circle of Authority
    | `137` -- instance_phantom_of_delphinad - Delphinad Mirage
    | `138` -- instance_arena_2on2 - Test Arena
    | `139` -- o_land_of_magic - Mysthrane Gorge
    | `140` -- o_mount_ipnir - Ipnya Ridge
    | `141` -- instance_garuda_nest - Skyfin War
    | `142` -- instance_mount_ipnir_story - Queen's Altar
    | `143` -- instance_event_camp_1on1 - Event Arena
    | `144` -- test_cbush - Guild House
    | `145` -- instance_black_thorn - Unused
    | `146` -- instance_black_spike - Black Thorn Prison
    | `147` -- o_western_prairie - Great Prairie of the West
    | `148` -- instance_nachashgar_ancient - Greater Serpentis
    | `149` -- instance_cuttlefish_event_zone - Squid Game Event Arena
    | `150` -- instance_dimensional_defence - Dimensional Boundary Defense Raid
    | `151` -- instance_event_hanuimaru - Ahnimar Event Arena
    | `152` -- w_golden_moss_forest - Goldleaf Forest
    | `153` -- instance_training_camp_1on1_ga - Make a Splash
    | `154` -- instance_burntcastle_armory_nightmare - Nightmare Burnt Castle Armory
    | `155` -- instance_divided_crossroad - Crossroads Arena
    | `156` -- instance_noryette_battlefield - Noryette Arena
    | `158` -- instance_life_dungeon_daru - Island of Abundance
    | `159` -- instance_golden_plains_ga - Golden Plains Battle

-- api/X2Resident
filterindex:
    | `HOUSING_LIST_FILTER_ALL`
    | `HOUSING_LIST_FILTER_FARM`
    | `HOUSING_LIST_FILTER_FLOATING`
    | `HOUSING_LIST_FILTER_HOUSE_NAME`
    | `HOUSING_LIST_FILTER_LARGE`
    | `HOUSING_LIST_FILTER_MANSION`
    | `HOUSING_LIST_FILTER_MEDIUM`
    | `HOUSING_LIST_FILTER_PUBLIC`
    | `HOUSING_LIST_FILTER_SELLER_NAME`
    | `HOUSING_LIST_FILTER_SMALL`
    | `HOUSING_LIST_FILTER_UNDERWATER_STRUCTURE`
    | `HOUSING_LIST_FILTER_WORKTABLE`