wow_Meta/C_ToyBox.lua

---@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,
}