Engine
GuidesTutorialsReferenceResourcesArtDesign

CatalogSearchParams

Show Deprecated

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

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:

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 ipairs(types) do

  print(val)

end

-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only

Summary

Properties

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.

SortAggregation: Enum.CatalogSortAggregation

The time period to use to aggregate the sort results.

CategoryFilter: CatalogCategoryFilter

The category to filter the search by.

SalesTypeFilter: Enum.SalesTypeFilter

The sales type filter the search by.

BundleTypes: Array<BundleType>

An array containing Enum.BundleType values to filter the search by.

AssetTypes: Array<AvatarAssetType>

An array containing AvatarAssetType values to filter the search by.

IncludeOffSale: boolean

Whether off sale items should be included in the results.

CreatorName: string

Search for items with the given creator.

Properties

SearchKeyword

string

The keyword to search for catalog results with.

MinPrice

number

The minimum item price to search for.

0

MaxPrice

number

The maximum item price to search for.

Default Value: 2147483647

SortType

CatalogSortType

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

Default Value: Enum.CatalogSortType.Relevance

SortAggregation

Enum.CatalogSortAggregation

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

Default Value: Enum.CatalogSortAggregation.AllTime

CategoryFilter

CatalogCategoryFilter

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

Default Value: Enum.CatalogCategoryFilter.None

SalesTypeFilter

Enum.SalesTypeFilter

The sales type the search by, represented by a Enum.SalesTypeFilter.

Default Value: Enum.SalesTypeFilter.All

BundleTypes

Array<BundleType>

An array containing Enum.BundleType values to filter the search by.

Default Value: {}

AssetTypes

Array<AvatarAssetType>

An array containing AvatarAssetType values to filter the search by.

IncludeOffSale

boolean

Whether off sale items should be included in the results.

CreatorName

string

Search for items with the given creator.