Hand-written by Joseph San Nicolas, Roblox Developer

CatalogSearchParams

Constructors

Name	Description
new()	Returns a new CatalogSearchParams with default values. Set its properties, then pass it to AvatarEditorService:SearchCatalogAsync() to run a catalog search.

Code Snippet

local AvatarEditorService = game:GetService("AvatarEditorService")

local params = CatalogSearchParams.new()
params.SearchKeyword = "hat"
params.MinPrice = 0
params.MaxPrice = 500
params.SortType = Enum.CatalogSortType.Relevance
params.AssetTypes = {Enum.AvatarAssetType.HatAccessory}

local pages = AvatarEditorService:SearchCatalogAsync(params)
local results = pages:GetCurrentPage()

for _, item in results do
    print(item.Name, item.Price)
end

Properties

Name	Type	Description
SearchKeyword	string	The keyword to search for catalog results with.
MinPrice	number	The minimum item price to search for. Defaults to 0.
MaxPrice	number	The maximum item price to search for. Defaults to 2147483647.
SortType	Enum.CatalogSortType	The order in which to sort the results. Defaults to Relevance.
SortAggregation	Enum.CatalogSortAggregation	The time period to aggregate the sort results by. Only applies when SortType is MostFavorited or BestSelling. Defaults to AllTime.
CategoryFilter	Enum.CatalogCategoryFilter	The category to filter the search by. Defaults to None.
SalesTypeFilter	Enum.SalesTypeFilter	The sales type to filter the search by. Defaults to All.
BundleTypes	Array<Enum.BundleType>	An array of Enum.BundleType values to filter the search by. Accessing this property returns a read-only table. Defaults to an empty array.
AssetTypes	Array<Enum.AvatarAssetType>	An array of Enum.AvatarAssetType values to filter the search by. Accessing this property returns a read-only table.
IncludeOffSale	boolean	Whether off-sale items should be included in the results. Defaults to false.
CreatorName	string	Search for items with the given creator name. Use CreatorType to specify whether to search users, groups, or both. Cannot be combined with CreatorId.
CreatorType	Enum.CreatorTypeFilter	Search for items created by the given creator type. Defaults to All (both User and Group).
CreatorId	number	Search for items created by the given single creator ID. Defaults to 0.
Limit	number	The number of items to return per page. Accepts 10, 28, 30, 60, or 120. Defaults to 30.