Module roboat::catalog::catalog_types

Types related to the avatar catalog. They are in this module because there are so many.

Structs

• AvatarSearchQuery
  Information comes directly from here https://create.roblox.com/docs/studio/catalog-api#marketplace-api.
• AvatarSearchQueryBuilder
  A builder for AvatarSearchQuery.
• Item
  Contains an item id and its type. Used as part of a parameter in Client::item_details, and used as part of a response in Client::avatar_catalog_search.
• ItemDetails
  A struct containing (mostly) all the fields possibly returned from https://catalog.roblox.com/v1/catalog/items/details.
• PremiumPricing
  Additional details for premium pricing.

Enums

• AssetType
  An enum representing the type of the asset (hat, shirt, gear).
• BundleType
  An enum representing the type of bundle (BodyParts or AvatarAnimations).
• CatalogQueryLimit
  Limit the amount of results shown by the API when searching. Values can be found when entering an invalid limit to the API https://catalog.roblox.com/v1/search/items?limit=110.
• Category
  The broad category of an item for use in search (Clothing, Collectables).
• CreatorType
  The type of a creator (User, Group).
• Genre
  An enum representing the genre of an item (war, funny). Only used when returning info from item_details.
• ItemRestriction
  Restriction on an item (ThirteenPlus, Limited). Not sure why limited is here but I guess that’s how they do it.
• ItemStatus
  The status of an item (Sale, Exclusive).
• ItemType
  An enum representing the overall high level type of the item (Asset or Bundle)
• PriceStatus
  The price status of an item. Only applies to items not on sale (Free, Offsale).
• QueryGenre
  These are only used when making a search query.
• SaleLocationType
  An enum representing the sale location type of an asset. Only used when returning info from item_details.
• SalesTypeFilter
  Sort between different sale types of assets, used when searching. Values can be from here https://create.roblox.com/docs/reference/engine/enums/SalesTypeFilter.
• SortAggregation
  A time period for when a sort applies.
• SortType
  Sorting types that can be used in an item search.
• Subcategory
  A subcategory for items, used when searching.