C_HousingLayout
namespaceavailable in: camelotStatus in wowlua
41 functions: 0 implemented, 0 recorded, 41 guessed. 18 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AnyRoomsOnFloor | Whether the house has rooms on the floor. · by wowlua(floor: number): boolean | guessed |
CanSetViewedFloor | Whether the floor can be viewed. · by wowlua(floor: number): boolean | guessed |
CancelActiveLayoutEditing | Cancels the current layout change. · by wowlua() | guessed |
ConfirmStairChoice | Confirms the direction of the stairs being placed. · by wowlua(choice: HousingLayoutStairDirection?) | guessed |
DeselectFloorplan | Deselects the selected floorplan. · by wowlua() | guessed |
DeselectRoomOrDoor | Deselects the selected room or door. · by wowlua() | guessed |
GetBaseRoomFloor | Returns the floor of the house's base room. · by wowlua(): number | guessed |
GetHighestOccupiedFloorIndex | Returns the highest floor that has rooms. · by wowlua(): number | guessed |
GetLowestOccupiedFloorIndex | Returns the lowest floor that has rooms. · by wowlua(): number | guessed |
GetNumActiveRooms | Returns the number of rooms in the house. · by wowlua(): number | guessed |
GetRoomPlacementBudget | Returns the max room placement budget for the current owned house's interior; Can be increased via house level(): number? | guessed |
GetRoomPlayerIsIn | Returns the guid of the interior room the player is standing in, or nil if not currently standing in one(): string? | guessed |
GetSelectedBlueprintFloorplan | Returns the ID and name of the selected blueprint floorplan. · by wowlua(): (number?, string?) | guessed |
GetSelectedDoor | If a door is selected, returns its component id and the guid of the room it belongs to; Otherwise returns nothing(): (number?, string?) | guessed |
GetSelectedFloorplan | Returns the room ID of the selected floorplan, or nothing. · by wowlua(): number? | guessed |
GetSelectedRoom | If a Room is selected, returns the room's guid; Otherwise returns nothing(): string? | guessed |
GetSelectedStairwellRoomCount | Returns the number of rooms the selected stairwell connects. · by wowlua(): number | guessed |
GetSpentPlacementBudget | Returns how much of the current owned house's room placement budget has been spent; Different kinds of rooms take up different budget amounts, so this value isn't an individual room count, see GetNumActiveRooms for that(): number? | guessed |
GetViewedFloor | Returns the floor being viewed. · by wowlua(): number | guessed |
HasAnySelections | Returns true if any room, door, or floorplan is currently selected or being dragged(): boolean | guessed |
HasRoomPlacementBudget | Returns whether there's a max room placement budget available and active for the current player, in the current house's interior(): boolean | guessed |
HasSelectedBlueprintFloorplan | Whether a blueprint floorplan is selected. · by wowlua(): boolean | guessed |
HasSelectedDoor | Returns true if a door component is currently selected(): boolean | guessed |
HasSelectedFloorplan | Whether a floorplan is selected. · by wowlua(): boolean | guessed |
HasSelectedRoom | Returns true if a room is selected, will NOT return true if a door is selected(): boolean | guessed |
HasStairs | Whether the room has stairs. · by wowlua(roomRecordID: number): boolean | guessed |
HasValidConnection | Whether a room's connection point can connect to the given room. · by wowlua(roomGUID: string, componentID: number, roomId: number): boolean | guessed |
IsBaseRoom | Whether the room is the house's base room. · by wowlua(roomGUID: string): boolean | guessed |
IsDraggingRoom | Whether a room is being dragged, and a second flag about the drag. · by wowlua(): (boolean, boolean) | guessed |
MoveDraggedRoom | Attempt to move the room currently being dragged to a specific connection point on a specific other room(sourceDoorIndex: number, destRoom: string, destDoorIndex: number) | guessed |
MoveLayoutCamera | Starts or stops moving the layout camera in a direction. · by wowlua(direction: HousingLayoutCameraDirection, isPressed: boolean) | guessed |
RemoveRoom | Attempt to return a previously placed room to the House Chest(roomGUID: string) | guessed |
RoomHasStairs | Returns true of the provided roomGUID is a stairwell. Returns false if roomGUID is invalid(roomGUID: string): boolean | guessed |
RotateFocusedRoom | Rotates either the currently dragged or currently selected room, if either exist(isLeft: boolean) | guessed |
RotateRoom | Attempt to rotate an already placed room(roomGUID: string, isLeft: boolean) | guessed |
SelectFloorplan | Selects the floorplan of a room. · by wowlua(roomID: number) | guessed |
SetViewedFloor | Sets the floor being viewed. · by wowlua(floor: number) | guessed |
StartDrag | Starts dragging the selected room. · by wowlua() | guessed |
StopDrag | Stops dragging. · by wowlua() | guessed |
StopDraggingRoom | Stops dragging the room. · by wowlua() | guessed |
ZoomLayoutCamera | Zooms the layout camera in or out and returns whether it zoomed. · by wowlua(zoomIn: boolean): boolean | 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 |
|---|---|---|
HOUSING_LAYOUT_DOOR_SELECTED | roomGUID: string, componentID: number | not implemented |
HOUSING_LAYOUT_DOOR_SELECTION_CHANGED | hasSelection: boolean | not implemented |
HOUSING_LAYOUT_DRAG_TARGET_CHANGED | isDraggingRoom: boolean | not implemented |
HOUSING_LAYOUT_FLOORPLAN_SELECTION_CHANGED | hasSelection: boolean, roomID: number, blueprintShareCode: string? | not implemented |
HOUSING_LAYOUT_OCCUPIED_FLOOR_RANGE_CHANGED | lowestFloor: number, highestFloor: number | not implemented |
HOUSING_LAYOUT_PIN_FRAMES_RELEASED | no payload | not implemented |
HOUSING_LAYOUT_PIN_FRAME_ADDED | pinFrame: HousingLayoutPinFrame | not implemented |
HOUSING_LAYOUT_PIN_FRAME_RELEASED | pinFrame: HousingLayoutPinFrame | not implemented |
HOUSING_LAYOUT_ROOM_COMPONENT_THEME_SET_CHANGED | roomGUID: string, componentID: number, newThemeSet: number, result: HousingResult | not implemented |
HOUSING_LAYOUT_ROOM_MOVED | no payload | not implemented |
HOUSING_LAYOUT_ROOM_MOVE_INVALID | no payload | not implemented |
HOUSING_LAYOUT_ROOM_RECEIVED | playAddedSound: boolean | not implemented |
HOUSING_LAYOUT_ROOM_REMOVED | no payload | not implemented |
HOUSING_LAYOUT_ROOM_RETURNED | no payload | not implemented |
HOUSING_LAYOUT_ROOM_SELECTION_CHANGED | hasSelection: boolean | not implemented |
HOUSING_LAYOUT_ROOM_SNAPPED | no payload | not implemented |
HOUSING_LAYOUT_VIEWED_FLOOR_CHANGED | floor: number | not implemented |
SHOW_STAIR_DIRECTION_CONFIRMATION | no payload | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("HOUSING_LAYOUT_DOOR_SELECTED").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingLayoutUI 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.