Roblox UtilitiesDevlHub Roblox Documentation

Data type

CatalogSearchParams

Stores parameters used in catalog searches via AvatarEditorService:SearchCatalogAsync().

The CatalogSearchParams data type stores the parameters of a catalog search via AvatarEditorService:SearchCatalogAsync().

When accessing the value of the CatalogSearchParams.BundleTypes or CatalogSearchParams.AssetTypes property the returned table will be read-only to avoid confusion when not directly accessing the CatalogSearchParams instance.

For example, you can use these properties as follows:

Luau
local params = CatalogSearchParams.new()
params.SearchKeyword = "Test"
params.MinPrice = 5000
params.MaxPrice = 10000
params.BundleTypes = {Enum.BundleType.Animations, Enum.BundleType.BodyParts}

local types = params.BundleTypes
for _, val in types do
  print(val)
end
-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only

Properties 14#

SearchKeywordstringThe keyword to search for catalog results with.
MinPricenumberThe minimum item price to search for.
MaxPricenumberThe maximum item price to search for.
SortTypeCatalogSortTypeThe order in which to sort the results.
SortAggregationEnum.CatalogSortAggregationThe time period to use to aggregate the sort results.
CategoryFilterCatalogCategoryFilterThe category to filter the search by.
SalesTypeFilterEnum.SalesTypeFilterThe sales type filter the search by.
BundleTypesArray<BundleType>An array containing BundleType values to filter the search by.
AssetTypesArray<AvatarAssetType>An array containing AvatarAssetType values to filter the search by.
IncludeOffSaleboolWhether off sale items should be included in the results.
CreatorNamestringSearch for items with the given creator name.
CreatorTypeEnum.CreatorTypeFilterSearch for items created by the given creator type.
CreatorIdnumberSearch for items created by the given creator ID.
LimitnumberSpecifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.

SearchKeyword: string#

The keyword to search for catalog results with.

MinPrice: number#

The minimum item price to search for.

MaxPrice: number#

The maximum item price to search for.

SortType: CatalogSortType#

The order in which to sort the results, represented by a CatalogSortType.

SortAggregation: Enum.CatalogSortAggregation#

The time period to use to aggregate the sort results by, represented by a CatalogSortAggregation. This only applies when the sort type is CatalogSortType.MostFavorited or CatalogSortType.BestSelling. It does not apply for other sort types.

CategoryFilter: CatalogCategoryFilter#

The category to filter the search by, represented by a CatalogCategoryFilter.

SalesTypeFilter: Enum.SalesTypeFilter#

The sales type to filter the search by, represented by a SalesTypeFilter. Use SalesTypeFilter.TimedOptions to return only items that have timed options available.

BundleTypes: Array<BundleType>#

An array containing BundleType values to filter the search by.

AssetTypes: Array<AvatarAssetType>#

An array containing AvatarAssetType values to filter the search by.

IncludeOffSale: bool#

Whether off sale items should be included in the results.

CreatorName: string#

Search for items with the given creator name. Specify whether to search users, groups, or both with CatalogSearchParams.CreatorType.

CreatorType: Enum.CreatorTypeFilter#

Search for items created by the given creator type. When unspecified, it defaults to returning creations from both CreatorTypeFilter.User and CreatorTypeFilter.Group. Searching by CatalogSearchParams.CreatorId with CreatorTypeFilter.All results in a HTTP 400 Bad Request error.

CreatorId: number#

Search for items created by the single creator ID. Specify user or group with CatalogSearchParams.CreatorType. Searching by creator ID and creator name is not supported; specify one, not both.

Limit: number#

Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.