C_Housing

namespaceavailable in: camelot

Status in wowlua

63 functions: 1 implemented, 4 recorded, 58 guessed. 39 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`AcceptNeighborhoodOwnership`	Accepts the offered ownership of a neighborhood. · by wowlua `()`	guessed
`CanEditCharter`	Whether the player can edit the neighborhood charter. · by wowlua `(): boolean`	guessed
`CanTakeReportScreenshot`	Returns the reason a screenshot cannot be taken to report a plot, or the value that means it can. · by wowlua `(plotIndex: number): InvalidPlotScreenshotReason`	guessed
`CreateGuildNeighborhood`	Creates a guild neighborhood with the given name. · by wowlua `(neighborhoodName: string)`	guessed
`CreateNeighborhoodCharter`	Creates a neighborhood charter with the given name. · by wowlua `(neighborhoodName: string)`	guessed
`DeclineNeighborhoodOwnership`	Declines the offered ownership of a neighborhood. · by wowlua `()`	guessed
`DoesFactionMatchNeighborhood`	Whether the player's faction matches the neighborhood's. · by wowlua `(neighborhoodGUID: string): boolean`	guessed
`EditNeighborhoodCharter`	Changes the name on the neighborhood charter. · by wowlua `(neighborhoodName: string)`	guessed
`GetCurrentHouseInfo`	Returns information about the house the player is in, or nothing. · by wowlua `(): HouseInfo?`	guessed
`GetCurrentHouseLevelFavor`	Requests the house's level and favor from the server. · by wowlua `(houseGuid: string)`	guessed
`GetCurrentHouseRefundAmount`	Returns the refund for giving up the current house. · by wowlua `(): number`	guessed
`GetCurrentNeighborhoodGUID`	Returns the GUID of the neighborhood the player is in, or nothing. · by wowlua `(): string?`	guessed
`GetHouseLevelFavorForLevel`	Returns the favor needed to reach a house level. · by wowlua `(level: number): number`	guessed
`GetHouseLevelRewardsForLevel`	Requests the rewards for reaching a house level from the server. · by wowlua `(level: number)`	guessed
`GetHousingAccessFlags`	Returns who may visit and use the player's house. · by wowlua `(): HouseSettingFlags`	guessed
`GetMaxHouseLevel`	Returns the highest house level. · by wowlua `(): number`	guessed
`GetNeighborhoodTextureSuffix`	Returns the texture name suffix of a neighborhood's map art. · by wowlua `(neighborhoodGUID: string): string`	guessed
`GetOthersOwnedHouses`	Requests the houses another player owns from the server. · by wowlua `(playerGUID: string?, bnetID: number?, isInPlayersGuild: boolean)`	guessed
`GetPlayerOwnedHouses`	Requests the houses the player owns from the server. · by wowlua `()`	guessed
`GetTrackedHouseGuid`	Returns the GUID of the tracked house, or nothing. · by wowlua `(): string?`	recorded
`GetUIMapIDForNeighborhood`	Returns the UI map ID of a neighborhood, or nothing. · by wowlua `(neighborhoodGuid: string): number?`	guessed
`GetVisitCooldownInfo`	Returns the cooldown of visiting a house, or nothing. · by wowlua `(): SpellCooldownInfo?`	guessed
`HasHousingExpansionAccess`	Whether the account has access to player housing. · by wowlua `(): boolean`	guessed
`HouseFinderDeclineNeighborhoodInvitation`	Declines the neighborhood invitation in the house finder. · by wowlua `()`	guessed
`HouseFinderIgnoreNeighborhood`	Hides a neighborhood from the house finder. · by wowlua `(neighborhoodGuid: string)`	guessed
`HouseFinderRequestNeighborhoods`	Requests the house finder's list of neighborhoods from the server. · by wowlua `()`	guessed
`HouseFinderRequestReservationAndPort`	Reserves a plot in a neighborhood and teleports there. · by wowlua `(neighborhoodGuid: string, plotID: number)`	guessed
`IsHousingMarketCartFullRemoveEnabled`	Whether the housing market cart can be emptied in one step. · by wowlua `(): boolean`	guessed
`IsHousingMarketEnabled`	Whether the housing market is available. · by wowlua `(): boolean`	guessed
`IsHousingMarketShopEnabled`	Whether the housing market shop is available. · by wowlua `(): boolean`	guessed
`IsHousingServiceEnabled`	Whether the housing service is available. · by wowlua `(): boolean`	recorded
`IsInsideHouse`	Whether the player is inside a house. · by wowlua `(): boolean`	recorded
`IsInsideHouseOrPlot`	Whether the player is inside a house or on a plot. · by wowlua `(): boolean`	recorded
`IsInsideOwnHouse`	Whether the player is inside their own house. · by wowlua `not in Blizzard's documentation`	guessed
`IsInsideOwnedHouse`	Whether the player is inside a house that has an owner. · by wowlua `(): boolean`	guessed
`IsInsideOwnedHouseOrPlot`	Whether the player is inside a house or on a plot that has an owner. · by wowlua `(): boolean`	guessed
`IsInsideOwnedPlot`	Whether the player is on a plot that has an owner. · by wowlua `(): boolean`	guessed
`IsInsidePlot`	Whether the player is on a plot. · by wowlua `(): boolean`	guessed
`IsOnNeighborhoodMap`	Whether the player is in a neighborhood. · by wowlua `(): boolean`	implemented
`LeaveHouse`	Leaves the house the player is in. · by wowlua `()`	guessed
`OnCharterConfirmationAccepted`	Tells the game that the neighborhood charter confirmation was accepted. · by wowlua `()`	guessed
`OnCharterConfirmationClosed`	Tells the game that the neighborhood charter confirmation was closed. · by wowlua `()`	guessed
`OnCreateCharterNeighborhoodClosed`	Tells the game that the window to create a charter neighborhood was closed. · by wowlua `()`	guessed
`OnCreateGuildNeighborhoodClosed`	Tells the game that the window to create a guild neighborhood was closed. · by wowlua `()`	guessed
`OnHouseFinderClickPlot`	Tells the game that a plot was clicked in the house finder. · by wowlua `(plotID: number)`	guessed
`OnRequestSignatureClicked`	Tells the game that the button to request charter signatures was clicked. · by wowlua `()`	guessed
`OnSignCharterClicked`	Signs another player's neighborhood charter. · by wowlua `(charterOwnerGUID: string)`	guessed
`RelinquishHouse`	Gives up ownership of a house. · by wowlua `(houseGuid: string)`	guessed
`RequestCurrentHouseInfo`	Requests information about the house the player is in from the server. · by wowlua `()`	guessed
`RequestHouseFinderNeighborhoodData`	Requests a neighborhood's data for the house finder from the server. · by wowlua `(neighborhoodGuid: string, neighborhoodName: string)`	guessed
`RequestPlayerCharacterList`	Requests the player's character list from the server. · by wowlua `()`	guessed
`ResetHouse`	Resets all contents of the house, based on the provided scope; API restricted to ensure this can't be triggered without the player getting ample notice and confirmation `(resetScope: HousingHouseScope)`	guessed
`ReturnAfterVisitingHouse`	Returns the player to where they were before visiting a house. · by wowlua `()`	guessed
`SaveHouseSettings`	Saves who may visit and use a player's house. · by wowlua `(playerGUID: string, accessFlags: HouseSettingFlags)`	guessed
`SearchBNetFriendNeighborhoods`	Searches a Battle.net friend's neighborhoods by name and returns whether the search started. · by wowlua `(bnetName: string): boolean`	guessed
`SearchBNetFriendNeighborhoodsByID`	Searches a Battle.net friend's neighborhoods by account ID and returns whether the search started. · by wowlua `(bnetID: number): boolean`	guessed
`SetTrackedHouseGuid`	Sets the tracked house, or clears it when omitted. · by wowlua `(trackedHouse: string?)`	guessed
`StartTutorial`	Starts the housing tutorial. · by wowlua `()`	guessed
`TeleportHome`	Teleports the player to their house. · by wowlua `(neighborhoodGUID: string, houseGUID: string, plotID: number)`	guessed
`TryRenameNeighborhood`	Tries to rename the neighborhood. · by wowlua `(neighborhoodName: string)`	guessed
`ValidateCreateGuildNeighborhoodSize`	Asks the server whether the guild is large enough to create a guild neighborhood. · by wowlua `()`	guessed
`ValidateNeighborhoodName`	Asks the server whether the name can be used for a neighborhood. · by wowlua `(neighborhoodName: string)`	guessed
`VisitHouse`	Visits a house. · by wowlua `(neighborhoodGUID: string, houseGUID: string, plotID: number)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`ADD_NEIGHBORHOOD_CHARTER_SIGNATURE`	`signature: string`	not implemented
`B_NET_NEIGHBORHOOD_LIST_UPDATED`	`result: HousingResult, neighborhoodInfos: NeighborhoodInfo[]?`	not implemented
`CLOSE_CHARTER_CONFIRMATION_UI`	`no payload`	not implemented
`CLOSE_CREATE_CHARTER_NEIGHBORHOOD_UI`	`no payload`	not implemented
`CLOSE_CREATE_GUILD_NEIGHBORHOOD_UI`	`no payload`	not implemented
`CREATE_NEIGHBORHOOD_RESULT`	`result: HousingResult, neighborhoodName: string?`	not implemented
`CURRENT_HOUSE_INFO_RECIEVED`	`houseInfo: HouseInfo`	not implemented
`CURRENT_HOUSE_INFO_UPDATED`	`houseInfo: HouseInfo`	not implemented
`DECLINE_NEIGHBORHOOD_INVITATION_RESPONSE`	`success: boolean`	not implemented
`FORCE_REFRESH_HOUSE_FINDER`	`no payload`	not implemented
`HOUSE_FINDER_NEIGHBORHOOD_DATA_RECIEVED`	`neighborhoodPlots: NeighborhoodPlotMapInfo[]`	not implemented
`HOUSE_INFO_UPDATED`	`no payload`	not implemented
`HOUSE_LEVEL_CHANGED`	`newHouseLevelInfo: HouseLevelInfo?`	not implemented
`HOUSE_LEVEL_FAVOR_UPDATED`	`houseLevelFavor: HouseLevelFavor`	not implemented
`HOUSE_PLOT_ENTERED`	`no payload`	not implemented
`HOUSE_PLOT_EXITED`	`no payload`	not implemented
`HOUSE_RESERVATION_RESPONSE_RECIEVED`	`result: HousingResult`	not implemented
`HOUSE_RESET_COMPLETED`	`no payload`	not implemented
`HOUSE_RESET_FAILED`	`result: HousingResult`	not implemented
`HOUSING_MARKET_AVAILABILITY_UPDATED`	`no payload`	not implemented
`HOUSING_SERVICES_AVAILABILITY_UPDATED`	`no payload`	not implemented
`IGNORE_NEIGHBORHOOD_RESPONSE`	`success: boolean, neighborhoodGuid: string`	not implemented
`MOVE_OUT_RESERVATION_UPDATED`	`no payload`	not implemented
`NEIGHBORHOOD_GUILD_SIZE_VALIDATED`	`approved: boolean`	not implemented
`NEIGHBORHOOD_LIST_UPDATED`	`result: HousingResult, neighborhoodInfos: NeighborhoodInfo[]?`	not implemented
`NEIGHBORHOOD_NAME_VALIDATED`	`approved: boolean`	not implemented
`NEW_HOUSING_ITEM_ACQUIRED`	`itemType: HousingItemToastType, itemName: string, icon: number?`	not implemented
`OPEN_CHARTER_CONFIRMATION_UI`	`neighborhoodName: string, locationName: string`	not implemented
`OPEN_CREATE_CHARTER_NEIGHBORHOOD_UI`	`locationName: string`	not implemented
`OPEN_CREATE_GUILD_NEIGHBORHOOD_UI`	`locationName: string`	not implemented
`OPEN_NEIGHBORHOOD_CHARTER`	`neighborhoodInfo: NeighborhoodInfo, signatures: string[], requiredSignatures: number`	not implemented
`OPEN_NEIGHBORHOOD_CHARTER_SIGNATURE_REQUEST`	`neighborhoodInfo: NeighborhoodInfo`	not implemented
`PLAYER_CHARACTER_LIST_UPDATED`	`characterInfos: HouseOwnerCharacterInfo[], ownerListIndex: number`	not implemented
`PLAYER_HOUSE_LIST_UPDATED`	`houseInfos: HouseInfo[]`	not implemented
`RECEIVED_HOUSE_LEVEL_REWARDS`	`level: number, rewards: HouseLevelReward[]`	not implemented
`REMOVE_NEIGHBORHOOD_CHARTER_SIGNATURE`	`signature: string`	not implemented
`SHOW_NEIGHBORHOOD_OWNERSHIP_TRANSFER_DIALOG`	`neighborhoodName: string, cosmeticOwnerName: string`	not implemented
`TRACKED_HOUSE_CHANGED`	`trackedHouse: string?`	not implemented
`VIEW_HOUSES_LIST_RECIEVED`	`houseInfos: HouseInfo[]`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ADD_NEIGHBORHOOD_CHARTER_SIGNATURE").

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingUI system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.