C_HousingBlueprint
namespaceavailable in: camelotStatus in wowlua
19 functions: 0 implemented, 0 recorded, 19 guessed. 14 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
CanExportRoom | Returns true if the specific room is allowed to be exported(roomGUID: string): boolean | guessed |
CanExportTypeFromCurrentLocation | Returns true if the player's current location is a valid place to attempt to export a specific kind of blueprint(type: HousingBlueprintType): boolean | guessed |
CanImportTypeFromCurrentLocation | Returns true if the player's current location is a valid place to attempt to import a specific kind of blueprint(type: HousingBlueprintType): boolean | guessed |
DeleteBlueprint | Delete the specified owned blueprint; Listen for HousingBlueprintDeleteSuccess and HousingBlueprintDeleteFailure for results(blueprintID: number) | guessed |
ExportBlueprint | Saves out a new Blueprint of the specified type, using the specified name, if available, based on where the player is currently standing (see C_HousingBlueprint.GetExportAvailability); Listen for HOUSING_BLUEPRINT_EXPORT_SUCCESS and HOUSING_BLUEPRINT_EXPORT_FAILURE for results(type: HousingBlueprintType, name: string) | guessed |
ExportRoomBlueprint | Saves out a new Blueprint of the specified room, using the specified name, if available (see C_HousingBlueprint.GetExportAvailability); Listen for HOUSING_BLUEPRINT_EXPORT_SUCCESS and HOUSING_BLUEPRINT_EXPORT_FAILURE for results(name: string, roomGUID: string) | guessed |
GetBlueprintHyperlink | Returns a chat link to a house blueprint, or nothing. · by wowlua(blueprintShareCode: string): string? | guessed |
GetBlueprintTypeForCode | Returns what type of Blueprint the specified code is for; Will return HousingBlueprintType.None if code is invalid; Does NOT check whether the shareCode actually matches up to a real valid Blueprint(shareCode: string): HousingBlueprintType | guessed |
GetExportAvailability | Returns success if the player can currently export Blueprints, or a specific error type (ex: invalid location or permissions)(): HousingResult | guessed |
GetFeatureAvailability | Returns success if Blueprints as a feature is currently enabled and available(): HousingResult | guessed |
GetImportAvailability | Returns success if the player can currently import Blueprints, or a specific error type (ex: invalid location or permissions)(): HousingResult | guessed |
ImportBlueprint | Imports the specified blueprint, if available (see IsImportAvailable and CanImportTypeFromCurrentLocation); Listen for HousingBlueprintImportSuccess and HousingBlueprintImportFailure for results(shareCode: string) | guessed |
IsShareCodeValid | Returns true if the string matches the valid expected format for a Blueprint Share Code; Does NOT check whether the shareCode actually matches up to a real valid Blueprint(shareCode: string): boolean | guessed |
RenameBlueprint | Rename the specified owned blueprint to the specified name; Listen for HousingBlueprintRenameSuccess and HousingBlueprintRenameFailure for results(blueprintID: number, newName: string) | guessed |
RequestBlueprintCollection | Request the full list of all of the player's Blueprints; This is async, either the HOUSING_BLUEPRINT_COLLECTION_RECEIVED or HOUSING_BLUEPRINT_COLLECTION_FAILURE event will eventually be fired as a result() | guessed |
RequestBlueprintContents | Request the full contents of a specific Blueprint, in context of the current owned plot or house (if any); This is async as content info includes dynamic data from the server, either the HOUSING_BLUEPRINT_CONTENTS_RECEIVED or HOUSING_BLUEPRINT_CONTENTS_FAILURE event will eventually be fired as a result; Calling this again before a prior request has finished will cancel the prior request(shareCode: string) | guessed |
RequestBlueprintContentsForContext | Request the full contents of a specific Blueprint, either in context of a specific owned House or plot, or explicitly outside of any specific context; Typically used to update missing requirement info from previously-retrieved contents; See RequestBlueprintContents for other notes(shareCode: string, optionalHouseGUID: string?) | guessed |
StartImportRoomBlueprint | Start the process of importing a Room Blueprint. This will lead to Layout Mode being opened, so the player can then select an available door to attach the room to(shareCode: string) | guessed |
UpdateBlueprintStringFromInput | Returns the blueprint share code read from the entered text, or nothing. · by wowlua(inputShareCode: string): string? | 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_BLUEPRINTS_AVAILABILITY_CHANGED | no payload | not implemented |
HOUSING_BLUEPRINT_COLLECTION_FAILURE | result: HousingResult | not implemented |
HOUSING_BLUEPRINT_COLLECTION_RECEIVED | collection: HousingBlueprintCollection | not implemented |
HOUSING_BLUEPRINT_CONTENTS_FAILURE | blueprintShareCode: string, result: HousingResult | not implemented |
HOUSING_BLUEPRINT_CONTENTS_RECEIVED | contentInfo: HousingBlueprintContentInfo | not implemented |
HOUSING_BLUEPRINT_DELETE_FAILURE | blueprintID: number, result: HousingResult | not implemented |
HOUSING_BLUEPRINT_DELETE_SUCCESS | blueprintID: number | not implemented |
HOUSING_BLUEPRINT_EXPORT_FAILURE | result: HousingResult | not implemented |
HOUSING_BLUEPRINT_EXPORT_SUCCESS | blueprintShareCode: string | not implemented |
HOUSING_BLUEPRINT_IMPORT_FAILURE | result: HousingResult | not implemented |
HOUSING_BLUEPRINT_IMPORT_STARTED | no payload | not implemented |
HOUSING_BLUEPRINT_IMPORT_SUCCESS | no payload | not implemented |
HOUSING_BLUEPRINT_RENAME_FAILURE | blueprintID: number, result: HousingResult | not implemented |
HOUSING_BLUEPRINT_RENAME_SUCCESS | blueprintID: number, name: string | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("HOUSING_BLUEPRINTS_AVAILABILITY_CHANGED").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (HousingBlueprintUI 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.