Collapse Sidebar



CatalogSearchParams is an object for specifying the parameters of a catalog search.

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

For instance, these properties could be used 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


string CatalogSearchParams.SearchKeyword

Defaults to an empty string

int CatalogSearchParams.MinPrice

Defaults to 0

int CatalogSearchParams.MaxPrice

Defaults to MAXINT(2147483647)

CatalogSortType CatalogSearchParams.SortType

Defaults to Enum/CatalogSortType|Enum.CatalogSortType.Relevance

CatalogCategoryFilter CatalogSearchParams.CategoryFilter

Defaults to Enum/CatalogCategoryFilter|Enum.CatalogCategoryFilter.None

array CatalogSearchParams.BundleType

An array containing Enum/BundleType values. Defaults to an empty array

array CatalogSearchParams.AssetTypes

An array containing Enum/AssetType values. Defaults to an empty array