v0.13.8

C_HouseExterior

namespaceavailable in: camelot

Status in wowlua

23 functions: 0 implemented, 0 recorded, 23 guessed. 12 events, 0 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
CancelActiveExteriorEditingCancels all in-progress editing of house exterior fixtures, which will deselect any active targets
()
guessed
GetCoreFixtureOptionsInfoReturns the options for a core fixture of the house exterior, or nothing. · by wowlua
(coreFixtureType: HousingFixtureType): HousingCoreFixtureInfo?
guessed
GetCurrentHouseExteriorSizeReturns the size of the house exterior, or nothing. · by wowlua
(): HousingFixtureSize?
guessed
GetCurrentHouseExteriorTypeReturns the ID and name of the house exterior type. · by wowlua
(): (number?, string?)
guessed
GetFixtureDebugInfoForGUIDReturns debug information about a house exterior fixture, looked up by its GUID. · by wowlua
not in Blizzard's documentation
guessed
GetHouseExteriorSizeOptionsReturns the sizes the house exterior can have, or nothing. · by wowlua
(): HouseExteriorSizeOptionsInfo?
guessed
GetHouseExteriorTypeOptionsReturns the types the house exterior can have, or nothing. · by wowlua
(): HouseExteriorTypeOptionsInfo?
guessed
GetHoveredFixtureDebugInfoReturns debug information about the house exterior fixture under the cursor, or nil. Blizzard's PTR feedback tool uses it. · by wowlua
not in Blizzard's documentation
guessed
GetSelectedFixtureDebugInfoReturns debug information about the selected house exterior fixture. · by wowlua
not in Blizzard's documentation
guessed
GetSelectedFixturePointInfoReturns information about the selected fixture point, or nothing. · by wowlua
(): HousingFixturePointInfo?
guessed
HasHoveredFixtureWhether the cursor is over a fixture. · by wowlua
(): boolean
guessed
HasSelectedFixturePointWhether a fixture point is selected. · by wowlua
(): boolean
guessed
IsAnyDecorAttachedToCoreFixtureReturns true if any decor is attached to the specified core fixture type, OR any child fixtures attached to it; Will also return false if the type provided is not a core fixture type, or if not in Exterior Customization mode on an owned plot
(coreFixtureType: HousingFixtureType): boolean
guessed
IsAnyDecorAttachedToDoorReturns true if any decor is attached to the current House Exterior's door; Will also return false if not in Exterior Customization mode on an owned plot
(): boolean
guessed
IsAnyDecorAttachedToHouseExteriorReturns true if any decor is attached to any component of the current House Exterior; Will also return false if not in House Exterior Customization mode on an owned Plot
(): boolean
guessed
IsAnyDecorAttachedToSelectedFixturePointReturns true if any decor is attached to the Fixture occupying the currently selected fixture point; Will also return false if no point is currently selected, or if there is currently no Fixture there
(): boolean
guessed
IsExteriorDecorHiddenWhether the decor outside the house is hidden. · by wowlua
(): boolean
guessed
RemoveFixtureFromSelectedPointRemoves the fixture from the selected fixture point. · by wowlua
(attachedDecorAction: HousingFixtureDecorAction)
guessed
SelectCoreFixtureOptionChooses a core fixture of the house exterior. · by wowlua
(fixtureID: number, attachedDecorAction: HousingFixtureDecorAction)
guessed
SelectFixtureOptionPlaces a fixture at the selected fixture point. · by wowlua
(fixtureID: number, attachedDecorAction: HousingFixtureDecorAction)
guessed
SetExteriorDecorHiddenHides or shows the decor outside the house. · by wowlua
(decorHidden: boolean)
guessed
SetHouseExteriorSizeSets the size of the house exterior. · by wowlua
(size: HousingFixtureSize, attachedDecorAction: HousingFixtureDecorAction)
guessed
SetHouseExteriorTypeSets the type of the house exterior. · by wowlua
(houseExteriorTypeID: number, attachedDecorAction: HousingFixtureDecorAction)
guessed

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

Events

eventpayloadfired by the emulator
HOUSE_EXTERIOR_DECOR_HIDDEN_CHANGEDisDecorHidden: booleannot implemented
HOUSE_EXTERIOR_TYPE_UNLOCKEDfixtureID: numbernot implemented
HOUSING_CORE_FIXTURE_CHANGEDcoreFixtureType: HousingFixtureTypenot implemented
HOUSING_FIXTURE_HOVER_CHANGEDanyHovered: booleannot implemented
HOUSING_FIXTURE_POINT_FRAMES_RELEASEDno payloadnot implemented
HOUSING_FIXTURE_POINT_FRAME_ADDEDpointFrame: HousingFixturePointFramenot implemented
HOUSING_FIXTURE_POINT_FRAME_RELEASEDpointFrame: HousingFixturePointFramenot implemented
HOUSING_FIXTURE_POINT_SELECTION_CHANGEDhasSelection: booleannot implemented
HOUSING_FIXTURE_UNLOCKEDfixtureID: numbernot implemented
HOUSING_SET_EXTERIOR_HOUSE_SIZE_RESPONSEresult: HousingResultnot implemented
HOUSING_SET_EXTERIOR_HOUSE_TYPE_RESPONSEresult: HousingResultnot implemented
HOUSING_SET_FIXTURE_RESPONSEresult: HousingResultnot implemented

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

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HouseExteriorUI 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.