C_HouseEditor
namespaceavailable in: camelotStatus in wowlua
10 functions: 1 implemented, 0 recorded, 9 guessed. 3 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
ActivateHouseEditorMode | Attempts switch the House Editor to a specific House Editor mode(editMode: HouseEditorMode): HousingResult | guessed |
EnterHouseEditor | Attempts to open the House Editor to the default House Editor mode(): HousingResult | guessed |
GetActiveHouseEditorMode | Returns the active house editor mode. · by wowlua(): HouseEditorMode | guessed |
GetHouseEditorAvailability | Returns the availability state of the House Editor overall(): HousingResult | guessed |
GetHouseEditorModeAvailability | Returns the availability of a specific House Editor mode(editMode: HouseEditorMode): HousingResult | guessed |
GetHouseEditorPlayerType | Returns the player's role in the house editor. · by wowlua(): HouseEditorPlayerType | guessed |
IsHouseEditorActive | Returns whether the House Editor is active, in any mode(): boolean | implemented |
IsHouseEditorModeActive | Returns whether the specific House Editor mode is active(editMode: HouseEditorMode): boolean | guessed |
IsHouseEditorStatusAvailable | Returns true if the HouseEditor currently able process mode availability and switching; May be false if not in a house or plot, or while waiting to get house settings back from the server(): boolean | guessed |
LeaveHouseEditor | Leaves the house editor. · by wowlua() | 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 |
|---|---|---|
HOUSE_EDITOR_AVAILABILITY_CHANGED | no payload | not implemented |
HOUSE_EDITOR_MODE_CHANGED | currentEditMode: HouseEditorMode | not implemented |
HOUSE_EDITOR_MODE_CHANGE_FAILURE | result: HousingResult | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("HOUSE_EDITOR_AVAILABILITY_CHANGED").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HouseEditorUI 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.