From 1de7c06df39cf93111ac23f4992e3df915130705 Mon Sep 17 00:00:00 2001 From: PhatPhuckDave Date: Sun, 18 May 2025 00:39:25 +0200 Subject: [PATCH] Add C_ToyBox module with functions for managing toy box operations --- C_ToyBox.lua | 135 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 C_ToyBox.lua diff --git a/C_ToyBox.lua b/C_ToyBox.lua new file mode 100644 index 0000000..b6bbc44 --- /dev/null +++ b/C_ToyBox.lua @@ -0,0 +1,135 @@ +---@meta +--- +--- C_ToyBox is a namespace for functions related to the toy box system. +--- +--- @class C_ToyBox +C_ToyBox = { + --- @return nil + --- Forces a refilter of toys. + ForceToyRefilter = function() end, + + --- @return boolean + --- Returns whether collected toys are shown. + GetCollectedShown = function() end, + + --- @param itemID number + --- @return boolean isFavorite + --- Returns whether a toy is marked as favorite. + GetIsFavorite = function(itemID) end, + + --- @return number + --- Returns the number of filtered toys. + GetNumFilteredToys = function() end, + + --- @return number + --- Returns the number of learned displayed toys. + GetNumLearnedDisplayedToys = function() end, + + --- @return number + --- Returns the total number of displayed toys. + GetNumTotalDisplayedToys = function() end, + + --- @return number numToys + --- Returns the total number of toys. + GetNumToys = function() end, + + --- @param index number + --- @return number itemID + --- Returns the toy ID from the specified index. + GetToyFromIndex = function(index) end, + + --- @param itemID number + --- @return number itemID + --- @return string toyName + --- @return string icon + --- @return boolean isFavorite + --- @return boolean hasFanfare + --- @return number itemQuality + --- Returns information about a toy. + GetToyInfo = function(itemID) end, + + --- @param itemID number + --- @return string itemLink + --- Returns the item link for a toy. + GetToyLink = function(itemID) end, + + --- @return boolean + --- Returns whether uncollected toys are shown. + GetUncollectedShown = function() end, + + --- @return boolean + --- Returns whether unusable toys are shown. + GetUnusableShown = function() end, + + --- @return boolean + --- Returns whether there are any favorites. + HasFavorites = function() end, + + --- @param expansionIndex number + --- @return boolean + --- Returns whether the specified expansion type filter is checked. + IsExpansionTypeFilterChecked = function(expansionIndex) end, + + --- @param sourceIndex number + --- @return boolean + --- Returns whether the specified source type filter is checked. + IsSourceTypeFilterChecked = function(sourceIndex) end, + + --- @param itemID number + --- @return boolean + --- Returns whether a toy is usable. + IsToyUsable = function(itemID) end, + + --- @param itemID number + --- @return nil + --- Picks up a toy box item. + PickupToyBoxItem = function(itemID) end, + + --- @param checked boolean + --- @return nil + --- Sets all expansion type filters. + SetAllExpansionTypeFilters = function(checked) end, + + --- @param checked boolean + --- @return nil + --- Sets all source type filters. + SetAllSourceTypeFilters = function(checked) end, + + --- @param checked boolean + --- @return nil + --- Sets whether collected toys are shown. + SetCollectedShown = function(checked) end, + + --- @param expansionIndex number + --- @param checked boolean + --- @return nil + --- Sets the specified expansion type filter. + SetExpansionTypeFilter = function(expansionIndex, checked) end, + + --- @param searchString string + --- @return nil + SetFilterString = function(searchString) end, + --- Sets the filter string for searching toys. + + --- @param itemID number + --- @param value boolean + --- @return nil + --- Sets a toy as favorite or not. + SetIsFavorite = function(itemID, value) end, + + --- @param sourceIndex number + --- @param checked boolean + --- @return nil + --- Sets the specified source type filter. + SetSourceTypeFilter = function(sourceIndex, checked) end, + + --- @param checked boolean + --- @return nil + --- Sets whether uncollected toys are shown. + SetUncollectedShown = function(checked) end, + + --- @param checked boolean + --- @return nil + --- Sets whether unusable toys are shown. + SetUnusableShown = function(checked) end, +}