The Deadlock Wiki

Module:AbilityHints: Difference between revisions

Browse history interactively
← Older edit

~2026-NeutralFleetfootMystic834 (talk)

2 edits
undo
Vergir (talk | contribs)
Contributors, Interface administrators
1,624 edits
mNo edit summary
Use the standard interacts text for the enhanced state (with help from vergir-bot LLM)
 
(29 intermediate revisions by 7 users not shown)
Line 1: Line 1:
-- Ability interaction hints: small item icons on ability cards showing how an
-- Small item icons on ability cards showing how an ability interacts with items (dispellable, reduced, blocked, etc.).
-- ability interacts with items (dispellable, reduced, blocked, etc.).
-- Used by Template:AbilitySection. Styles are there too.
-- Membership is decided by Module:AbilityTable.is_member so these icons always
 
-- agree with the dynamic ability-interaction tables.
-- label_dict_key names the [[Data:Dictionary]] entry holding the tooltip text. It is
-- resolved at render time rather than here, so the tooltip follows the page language
-- and so no frame is needed while the module is still loading.
local CONFIG = {
    { list = "melee",            file = "Melee Lifesteal.png",  label_dict_key = "AbilityHintsMelee" },
    { list = "dontbreakstealth", file = "Veil Walker.png",      label_dict_key = "AbilityHintsDontBreakStealth" },
    { list = "movementbased",    file = "Slowing Hex.png",      label_dict_key = "AbilityHintsMovementBased" },
    { list = "debuffresist",    file = "Debuff Reducer.png",  label_dict_key = "AbilityHintsDebuffResist" },
    { list = "heal",            file = "Healing Booster.png",  label_dict_key = "AbilityHintsHeal" },
    { list = "healingtempo",    file = "Healing Tempo.png",    label_dict_key = "AbilityHintsHealingTempo" },
    { list = "reactivebarrier",  file = "Reactive Barrier.png", label_dict_key = "AbilityHintsReactiveBarrier" },
    { list = "dispelmagic",      file = "Dispel Magic.png",    label_dict_key = "AbilityHintsDispelMagic" },
    { list = "indomitable",      file = "Indomitable.png",      label_dict_key = "AbilityHintsIndomitable" },
    { list = "unstoppable",      file = "Unstoppable.png",      label_dict_key = "AbilityHintsUnstoppable" },
    { list = "platedarmor",      file = "Plated Armor.png",    label_dict_key = "AbilityHintsPlatedArmor" },
    { list = "summons",          file = "Monster Rounds.png",  label_dict_key = "AbilityHintsSummons" },
}
 
-- Tooltip wording for a manually placed icon, keyed by its iconbox state. Each entry
-- takes the item title as {{{1}}}, so translations can put the object where their
-- grammar wants it rather than always after the verb. The enhanced state has no entry
-- of its own: the glow already marks it, so it falls through to the normal wording.
local STATE_DICT_KEYS = {
    normal  = "AbilityHintsInteracts",
    disabled = "AbilityHintsInteractsNot",
    partial  = "AbilityHintsInteractsPartial",
}


local AbilityTable = require("Module:AbilityTable")
local AbilityTable = require("Module:AbilityTable")
local icon_module  = require("Module:Icon")
local dictionary = require("Module:Dictionary")
local ability_data = mw.loadJsonData("Data:AbilityData.json")
local resource_lookup = mw.loadJsonData("Data:ResourceLookup.json")
local item_data = mw.loadJsonData("Data:ItemData.json")


local p = {}
local p = {}


-- Display order. Each entry:
-- Display order: item type (Weapon => Vitality => Spirit), then cost, then name.
--  list          AbilityTable list name (Module:AbilityTable/Lists)
local function sort_key(file)
--  item          item whose icon represents the interaction
    local base = mw.ustring.lower((file:gsub('%.%w+$', '')))
--  tip            short hover text
    local entry = resource_lookup[base]
--  suppressed_by  optional: hide this icon when the named list is also a member
     local item = (entry ~= nil and entry.type == 'item') and item_data[entry.key] or nil
local CONFIG = {
    if item == nil then
     { list = "melee",          item = "Melee Lifesteal",  tip = "Benefits from Melee Damage" },
        return { 99, math.huge, base }
{ list = "reactivebarrier", item = "Reactive Barrier", tip = "Triggers Reactive Barrier" },
    end
{ list = "debuffresist",    item = "Debuff Reducer",  tip = "Duration reduced by Debuff Resist" },
    local slot = item["Slot"]
     { list = "movementbased",   item = "Slowing Hex",     tip = "Disabled by Slowing Hex" },
    local slot_rank = (slot == "Weapon" and 1) or (slot == "Armor" and 2) or (slot == "Tech" and 3) or 98
     { list = "heal",           item = "Healing Booster", tip = "Amplified by Healing Booster and affected by Healing Reduction" },
     return {
     { list = "dispelmagic",     item = "Dispel Magic",    tip = "Effect can be dispelled" },
        slot_rank,
    { list = "charges",        item = "Rapid Recharge",  tip = "Charged ability" },
        tonumber(item["Cost"]) or math.huge,
     { list = "divinebarrier",  item = "Divine Barrier",  tip = "Effect can be dispelled by Divine Barrier (but not Dispel Magic)", suppressed_by = "dispelmagic" },
        mw.ustring.lower(item["Name"] or base),
     { list = "indomitable",     item = "Indomitable",      tip = "Effect blocked by Indomitable", suppressed_by = "reactivebarrier" },
    }
     { list = "unstoppable",     item = "Unstoppable",      tip = "Prevented by Unstoppable" },
end
     { list = "cursedrelic",     item = "Cursed Relic",    tip = "Interrupted by Cursed Relic" },
 
     { list = "platedarmor",     item = "Plated Armor",     tip = "Prevented by Plated Armor" },
local function compare(a, b)
}
     for i = 1, 3 do
        if a.sort[i] ~= b.sort[i] then return a.sort[i] < b.sort[i] end
    end
    return false
end
 
-- partial: split the icon so the top-left half is grayscale (mirrors the iconbox-partial box icon).
-- An empty link makes the icon non-clickable; automatic hints link from their tooltip text instead.
local function icon_img(file, link, partial)
     link = link or ''
     if partial then
        return '<span class="ability-hint-icon"><span class="ability-hint-split">'
            .. '[[File:' .. file .. '|24px|link=' .. link .. ']]'
            .. '<span class="ability-hint-split-gray">[[File:' .. file .. '|24px|link=]]</span>'
            .. '</span></span>'
    end
    return '<span class="ability-hint-icon">[[File:' .. file .. '|24px|link=' .. link .. ']]</span>'
end
 
local function hint_icon(def)
     return '<span class="ability-hint">' .. icon_img(def.file)
        .. '<span class="ability-hint-tip">' .. dictionary.translate(def.label_dict_key) .. '</span></span>'
end
 
local function manual_icon(m)
    local cls = 'ability-hint'
    local dict_key = STATE_DICT_KEYS.normal
     local partial = false
     if m.state == 'disabled' then
        cls = cls .. ' ability-hint--disabled'
        dict_key = STATE_DICT_KEYS.disabled
     elseif m.state == 'partial' then
        dict_key = STATE_DICT_KEYS.partial
        partial = true
     elseif m.state == 'enhanced' then
        cls = cls .. ' ability-hint--enhanced'
    end
    local tip = dictionary.translate(dict_key, nil, nil, { m.title })
        .. '<br>' .. dictionary.translate('AbilityHintsClickReveal')
     return '<span class="' .. cls .. '">' .. icon_img(m.file, '#' .. m.anchor, partial)
        .. '<span class="ability-hint-tip">' .. tip .. '</span></span>'
end
 
function p.get_icons(ability_key, ability_num, manual)
     manual = manual or {}
 
     local manual_by_file = {}
    for _, m in ipairs(manual) do
        manual_by_file[mw.ustring.lower(m.file)] = m
     end
 
     local entries = {}
    local placed = {}


-- Renders the interaction icon rail for one ability.
--  ability_key  the ability's internal key (AbilityCards .Key)
--  ability_num  the ability's slot (1-4); coerced to number
-- Returns rail HTML, or '' when the ability has no interactions.
function p.get_icons(ability_key, ability_num)
    local record = ability_data[ability_key]
    if record == nil then return '' end
     local num = tonumber(ability_num)
     local num = tonumber(ability_num)
    local member = {}
     for _, def in ipairs(CONFIG) do
     for _, def in ipairs(CONFIG) do
         member[def.list] = AbilityTable.is_member(def.list, record, num)
         if AbilityTable.is_member(def.list, ability_key, num) then
            local key = mw.ustring.lower(def.file)
            local m = manual_by_file[key]
            if m ~= nil then
                table.insert(entries, { file = m.file, html = manual_icon(m) })
                placed[key] = true
            else
                table.insert(entries, { file = def.file, html = hint_icon(def) })
            end
        end
     end
     end


    local icons = {}
     for _, m in ipairs(manual) do
     for _, def in ipairs(CONFIG) do
         if not placed[mw.ustring.lower(m.file)] then
         if member[def.list] and not (def.suppressed_by and member[def.suppressed_by]) then
             table.insert(entries, { file = m.file, html = manual_icon(m) })
            -- Link via a full URL so the anchor has NO title attribute — that's
            -- what Page Previews (Popups) keys off of — while staying clickable.
            local url = tostring(mw.uri.canonicalUrl(def.item))
            local img = icon_module._render(def.item, { size = '24px', ['icon-only'] = 'true', link = url })
             table.insert(icons,
                '<span class="ability-hint">' .. img
                .. '<span class="ability-hint-tip">' .. def.tip .. '</span></span>'
            )
         end
         end
     end
     end


     if #icons == 0 then return '' end
     if #entries == 0 then return '' end
 
    for _, e in ipairs(entries) do e.sort = sort_key(e.file) end
    table.sort(entries, compare)
 
    local icons = {}
    for _, e in ipairs(entries) do table.insert(icons, e.html) end
 
     return '<div class="ability-section-hints">' .. table.concat(icons) .. '</div>'
     return '<div class="ability-section-hints">' .. table.concat(icons) .. '</div>'
end
end


return p
return p
Retrieved from "https://deadlock.wiki/Module:AbilityHints"