C_HousingNeighborhood
namespaceavailable in: camelotStatus in wowlua
30 functions: 0 implemented, 0 recorded, 30 guessed. 13 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
CanReturnAfterVisitingHouse | Whether the player can return to where they were before visiting a house. · by wowlua(): boolean | guessed |
CancelInviteToNeighborhood | Only available when interacting with a bulletin board game object(playerName: string) | guessed |
DemoteToResident | Only available when interacting with a bulletin board game object(playerGUID: string) | guessed |
GetCornerstoneHouseInfo | Only available when interacting with a cornerstone game object(): HouseInfo | guessed |
GetCornerstoneNeighborhoodInfo | Only available when interacting with a cornerstone game object(): NeighborhoodInfo | guessed |
GetCornerstonePurchaseMode | Only available when interacting with a cornerstone game object(): CornerstonePurchaseMode | guessed |
GetCurrentNeighborhoodTextureSuffix | Returns the texture name suffix of the current neighborhood's map art. · by wowlua(): string | guessed |
GetDiscountedMovePrice | Only available when interacting with a cornerstone game object(): number | guessed |
GetMoveCooldownTime | Only available when interacting with a cornerstone game object(): number | guessed |
GetNeighborhoodMapData | Returns the plots shown on the neighborhood map. · by wowlua(): NeighborhoodPlotMapInfo[] | guessed |
GetNeighborhoodName | Returns the neighborhood's name. · by wowlua(): string | guessed |
GetNeighborhoodPlotName | Returns the name of a plot in the neighborhood. · by wowlua(plotIndex: number): string | guessed |
GetPreviousHouseIdentifier | Only available when interacting with a cornerstone game object(): string | guessed |
HasPermissionToPurchase | Only available when interacting with a cornerstone game object(): PurchaseHouseDisabledReason | guessed |
InvitePlayerToNeighborhood | Only available when interacting with a bulletin board game object(playerName: string) | guessed |
IsNeighborhoodManager | Whether the player is a manager of the neighborhood. · by wowlua(): boolean | guessed |
IsNeighborhoodOwner | Whether the player owns the neighborhood. · by wowlua(): boolean | guessed |
IsPlayerInOtherPlayersPlot | This returns true if the player is in a plot that is owned by another player(): boolean | guessed |
IsPlotAvailableForPurchase | Only available when interacting with a cornerstone game object(): boolean | guessed |
IsPlotOwnedByPlayer | Only available when interacting with a cornerstone game object(): boolean | guessed |
OnBulletinBoardClosed | Tells the game that the neighborhood bulletin board was closed. · by wowlua() | guessed |
OnCornerstoneClosed | Tells the game that the plot's cornerstone window was closed. · by wowlua() | guessed |
PromoteToManager | Only available when interacting with a bulletin board game object(playerGUID: string) | guessed |
RequestNeighborhoodInfo | Requests the neighborhood's information from the server. · by wowlua() | guessed |
RequestNeighborhoodRoster | Only available when interacting with a bulletin board game object() | guessed |
RequestPendingNeighborhoodInvites | Only available when interacting with a bulletin board game object() | guessed |
TransferNeighborhoodOwnership | Only available when interacting with a bulletin board game object(playerGUID: string) | guessed |
TryEvictPlayer | Only available when interacting with a bulletin board game object(plotID: number) | guessed |
TryMoveHouse | Only available when interacting with a cornerstone game object() | guessed |
TryPurchasePlot | Only available when interacting with a cornerstone game object() | 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 |
|---|---|---|
CANCEL_NEIGHBORHOOD_INVITE_RESPONSE | result: NeighborhoodInviteResult, playerName: string? | not implemented |
CLOSE_PLOT_CORNERSTONE | no payload | not implemented |
NEIGHBORHOOD_INFO_UPDATED | neighborhoodInfo: NeighborhoodInfo | not implemented |
NEIGHBORHOOD_INVITE_RESPONSE | result: NeighborhoodInviteResult | not implemented |
NEIGHBORHOOD_MAP_DATA_UPDATED | no payload | not implemented |
NEIGHBORHOOD_NAME_UPDATED | neighborhoodGuid: string, neighborhoodName: string | not implemented |
OPEN_PLOT_CORNERSTONE | no payload | not implemented |
PENDING_NEIGHBORHOOD_INVITES_RECIEVED | result: NeighborhoodInviteResult, pendingInviteList: string[]? | not implemented |
PURCHASE_PLOT_RESULT | result: number | not implemented |
SHOW_PLAYER_EVICTED_DIALOG | no payload | not implemented |
UPDATE_BULLETIN_BOARD_MEMBER_TYPE | player: string, residentType: ResidentType | not implemented |
UPDATE_BULLETIN_BOARD_ROSTER | neighborhoodInfo: NeighborhoodInfo, rosterMemberList: NeighborhoodRosterMemberInfo[] | not implemented |
UPDATE_BULLETIN_BOARD_ROSTER_STATUSES | rosterMemberList: NeighborhoodRosterMemberUpdateInfo[] | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("CANCEL_NEIGHBORHOOD_INVITE_RESPONSE").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingNeighborhoodUI 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.