Conditions.item.get_item_desc

Call as

Conditions.item.get_item_desc(items)

Record the dependency Conditions.item.get_item_desc, then call it by that name. A namespaced call does not pass self: use a colon call or pass the object yourself.

What it does

Describes an item reference for the item condition descriptions: an item set name (white for a profile set, cyan for a global one), or the first item's link or name followed by how many others are listed. Returns nil when the reference is invalid, the set is unknown, or the list is empty.

Arguments

Returns

Editions

Built In helpers are registered on every edition. What differs is the game API they read; where one is missing the helper falls back or returns nil with a reason.

It reads no game API directly.

How the addon calls it

• Have Item In Bags (print)

  item = Functions.presentation.nullable(get_item_desc(value.item), L["<item>"]),

• Have Item Equipped (print)

  return Literal.phrase(L["you {{!have|do not have}} {item} equipped"], {item = Functions.presentation.nullable(get_item_desc(value.item), L["<item>"])})

• Item Available (print)

  item = Functions.presentation.nullable(get_item_desc(value.item), L["<item>"]),

• Item Cooldown (print)

  item = Functions.presentation.nullable(get_item_desc(value.item), L["<item>"]),

• Item In Range (print)

  item = Functions.presentation.nullable(get_item_desc(value.item), L["<item>"]),

Dependencies

• color (builtin:Conditions/item.lua:color)

Source

Conditions/item.lua, line 62. Read only in game; Duplicate makes an editable copy.

    if not addon:IsConditionItemReference(items) then return nil end
    local itemsets = addon.db.profile.itemsets
    local global_itemsets = addon.db.global.itemsets
    if itemsets~=nil and type(itemsets)~='table' or global_itemsets~=nil and type(global_itemsets)~='table' then return nil end

    if type(items) == "string" then
        local set=(itemsets or {})[items];local tint=color.WHITE
        if set==nil then set=(global_itemsets or {})[items];tint=color.CYAN end
        if type(set)=='table' and type(set.name)=='string' then return string.format(L["a %s item set item"],tint..set.name..color.RESET) end
    elseif items and #items > 0 then
        local info=addon.Platform:GetItemMetadata(items[1])
        local link=info and (info.link or info.name) or items[1]
        if #items > 1 then
            return string.format(L["%s or %d others"], link, #items-1)
        else
            return link
        end
    end
    return nil