HousingCatalogSearcher
object type46 methodsavailable in: camelot
Methods
In the emulator: 46 implemented.
| method | what it does | status |
|---|---|---|
GetAllSearchItems | Returns all catalog entries being searched (note these are NOT search results, this is the source collection of what's being searched) · warcraft.wiki.gg ↗(): HousingCatalogEntryVariantID[] | implemented |
GetCatalogSearchResults | Returns the most recent search result entries · warcraft.wiki.gg ↗(): HousingCatalogEntryVariantID[] | implemented |
GetEditorModeContext | Returns the housing editor mode the search is for. · by wowlua(): HouseEditorMode? | implemented |
GetFilterTagStatus | Whether a filter tag of the search is turned on. · by wowlua(groupID: number, tagID: number): boolean | implemented |
GetFilteredCategoryID | Returns the category the search is limited to. · by wowlua(): number? | implemented |
GetFilteredSubcategoryID | Returns the subcategory the search is limited to. · by wowlua(): number? | implemented |
GetNumSearchItems | Returns the total number of entries being searched through · warcraft.wiki.gg ↗(): number | implemented |
GetSearchCount | Returns the total number of owned instances across all most recent search result entries · warcraft.wiki.gg ↗(): number | implemented |
GetSearchText | Returns the search text. · by wowlua(): string? | implemented |
GetSortType | Returns how the search results are sorted. · by wowlua(): HousingCatalogSortType | implemented |
IsAllowedIndoorsActive | Whether the filter for decor allowed indoors is on. · by wowlua(): boolean | implemented |
IsAllowedOutdoorsActive | Whether the filter for decor allowed outdoors is on. · by wowlua(): boolean | implemented |
IsBaseVariantOnlyActive | Returns whether the searcher includes only the base variant of each decor entry. · by wowlua(): boolean | implemented |
IsCollectedActive | Whether the filter for collected decor is on. · by wowlua(): boolean | implemented |
IsCustomizableOnlyActive | Whether the search shows only customizable decor. · by wowlua(): boolean | implemented |
IsFirstAcquisitionBonusOnlyActive | Whether the search shows only decor that gives a first acquisition bonus. · by wowlua(): boolean | implemented |
IsSearchInProgress | Whether a search is running. · by wowlua(): boolean | implemented |
IsStoredOnlyActive | Returns whether the searcher includes only entries the player has available in storage, not ones they own that are all placed. · by wowlua(): boolean | implemented |
IsUncollectedActive | Whether the filter for uncollected decor is on. · by wowlua(): boolean | implemented |
RunSearch | Run search with all current param values · warcraft.wiki.gg ↗() | implemented |
SetAllInFilterTagGroup | Set the toggle state of all filter tags within a specific group; If active, only entries that match Any of the tags in the group will be included in search results · warcraft.wiki.gg ↗(groupID: number, active: boolean) | implemented |
SetAllowedIndoors | Search parameter; If true, entries that can be placed in house interiors will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed outdoors · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetAllowedOutdoors | Search parameter; If true, entries that can be placed outside in plots will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed indoors · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetAutoUpdateOnParamChanges | If true, searcher automatically updates results whenever search param values are changed · warcraft.wiki.gg ↗(autoUpdateActive: boolean) | implemented |
SetBaseVariantOnly | Search parameter; If true, only the base variant of each decor entry will be included · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetCollected | Search parameter; If true, includes all owned entries, including those that are in storage OR placed in an owned house or plot; See IsOwnedOnlyActive for a more exclusive toggle · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetCustomizableOnly | Search parameter; If true, catalog entries that cannot be customized (ie dyed) will be excluded from the search · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetEditorModeContext | Search parameter; If set, limits search results to only entries that are used/valid in the specified editor mode · warcraft.wiki.gg ↗(editorModeContext: HouseEditorMode?) | implemented |
SetFilterTagStatus | Set the toggle state of a single filter tag within a specific group · warcraft.wiki.gg ↗(groupID: number, tagID: number, active: boolean) | implemented |
SetFilteredCategoryID | Search parameter; If set, limits search results to only those within the specified category · warcraft.wiki.gg ↗(categoryID: number?) | implemented |
SetFilteredSubcategoryID | Search parameter; If set, limits search results to only those within the specified subcategory · warcraft.wiki.gg ↗(subcategoryID: number?) | implemented |
SetFirstAcquisitionBonusOnly | Search parameter; If true, excludes any entries that do not reward house xp when acquired for the first time · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetResultsUpdatedCallback | Sets the function called when the search results update. · by wowlua(callback: HousingCatalogSearchResultsUpdatedCallback) | implemented |
SetSearchText | Search parameter; If set, multiple text fields are checked for instances of the text, including name, category, subcategory, and data tags · warcraft.wiki.gg ↗(searchText: string?) | implemented |
SetSortType | Sets how the search results are sorted. · by wowlua(sortType: HousingCatalogSortType) | implemented |
SetStoredOnly | Search parameter; If true, only entries that you have instances of available in storage will be included; This does not include entries that you own but have all been placed in a house; See IsCollectedActive for param that includes placed entries · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
SetUncollected | Search parameter; If true, includes entries that are not owned, meaning not available in storage nor placed in any owned houses or plots · warcraft.wiki.gg ↗(isActive: boolean) | implemented |
ToggleAllowedIndoors | Turns the filter for decor allowed indoors on or off. · by wowlua() | implemented |
ToggleAllowedOutdoors | Turns the filter for decor allowed outdoors on or off. · by wowlua() | implemented |
ToggleBaseVariantOnly | Turns the searcher's base-variant-only option on if it is off, or off if it is on. · by wowlua() | implemented |
ToggleCollected | Turns the filter for collected decor on or off. · by wowlua() | implemented |
ToggleCustomizableOnly | Turns showing only customizable decor on or off. · by wowlua() | implemented |
ToggleFilterTag | Turns a filter tag of the search on or off. · by wowlua(groupID: number, tagID: number) | implemented |
ToggleFirstAcquisitionBonusOnly | Turns showing only decor that gives a first acquisition bonus on or off. · by wowlua() | implemented |
ToggleStoredOnly | Turns the searcher's stored-only option on if it is off, or off if it is on. Replaces the older ToggleOwnedOnly. · by wowlua() | implemented |
ToggleUncollected | Turns the filter for uncollected decor on or off. · by wowlua() | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (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.