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

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

For example, you can use these properties as follows:

```lua
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
```


CatalogSearchParams

The keyword to search for catalog results with.


CatalogSearchParams.SearchKeyword

CatalogSearchParams.MinPrice

CatalogSearchParams.MaxPrice

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


CatalogSearchParams.SortType

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


CatalogSearchParams.CategoryFilter

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


CatalogSearchParams.BundleTypes

An array containing `Enum.AvatarAssetType` values to filter the search by.


CatalogSearchParams.AssetTypes

Whether off sale items should be included in the results.


CatalogSearchParams.IncludeNotForSale

Used in conjunction with `Datatype.CatalogSearchParams.CreatorId` to search for items created by a specific creator.


CatalogSearchParams.CreatorType

Search for items with the given creator.


CatalogSearchParams.CreatorId

Stores parameters used in catalog searches via
`Class.AvatarEditorService:SearchCatalog()`.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

CatalogSearchParams

Summary

Properties

Properties

SearchKeyword

MinPrice

MaxPrice

SortType

CategoryFilter

BundleTypes

AssetTypes

IncludeNotForSale

CreatorType

CreatorId