Pages Util

Utility for dealing with roblox pages instances easily

local AvatarEditorService = game:GetService("AvatarEditorService")
local pagesutil = require("pages")

local params = CatalogSearchParams.new()
parms.AssetTypes = { Enum.AvatarAssetType.Hat }
params.SearchKeyword = "meow"

local pages = AvatarEditorService:SearchCatalog(params)

if success then
	local kitty_item

	pagesutil.iter(pages, function(_, asset_info)
		if 
			string.find(asset_info.Name, ":3",  1, true) or 
			string.find(asset_info.Description, ":3", 1, true)
		then
			kitty_item = asset_info
			return "break"
		end
		-- this has to be here, otherwise a type error occurs
		return
	end)
end

Types

PageInfo

type PageInfo = {
	item_index: number,
	page_len: number,
	page: number,
}

• item_index - the index of the current item on the current page
• page_len - the total amount of indexes on the current page
• page - the current page being iterated through

Methods

iter

Iterates through the pages instance until complete and calls the given callback for each entry. iter will also stop iterating if the callback returns "break". So that you don't have to waste api calls for advancing through every single page.

local AvatarEditorService = game:GetService("AvatarEditorService")

local params = CatalogSearchParams.new()
parms.AssetTypes = { Enum.AvatarAssetType.Hat }
params.SearchKeyword = "mrrp"

local pages = AvatarEditorService:SearchCatalog(params)

pagesutil.iter(pages, function(page_info, asset_info)
	local index = page_info.item_index
	local name = asset_info.Name

	if string.find(name, ":3",  1, true) then
		print(`:3 {name} on page {page_info.page} at index {index}`)
		return "break"
	end
	return
end)

toarray

Converts the pages instance into a flat array

local AvatarEditorService = game:GetService("AvatarEditorService")

local params = CatalogSearchParams.new()
parms.AssetTypes = { Enum.AvatarAssetType.Hat }
params.SearchKeyword = "miaow"

local pages = AvatarEditorService:SearchCatalog(params)

for _, asset_info in pagesutil.toarray(pages) do
	local name = asset_info.Name

	if string.find(name, "mrow",  1, true) then
		print(`{name} is such a :3 item!!`)
	end
end