The Deadlock Wiki

Editing Module:AbilityHints

Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
-- Small item icons on ability cards showing how an ability interacts with items (dispellable, reduced, blocked, etc.).
-- Ability interaction hints: small item icons on ability cards showing how an
-- Used by Template:AbilitySection. Styles are there too.
-- ability interacts with items (dispellable, reduced, blocked, etc.).
 
-- Membership is decided by Module:AbilityTable.is_member so these icons always
-- label_dict_key names the [[Data:Dictionary]] entry holding the tooltip text. It is
-- agree with the dynamic ability-interaction tables.
-- 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 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: item type (Weapon => Vitality => Spirit), then cost, then name.
-- Display order. Each entry: { list, file, link, tip }
local function sort_key(file)
--  list  AbilityTable list whose membership shows the icon
    local base = mw.ustring.lower((file:gsub('%.%w+$', '')))
--  file  image file to display, e.g. "Reactive Barrier.png"
    local entry = resource_lookup[base]
--  link  URL opened when the icon is clicked. Use a full/absolute URL: it keeps
     local item = (entry ~= nil and entry.type == 'item') and item_data[entry.key] or nil
--        the anchor title-less, so MediaWiki Page Previews (Popups) ignores it.
     if item == nil then
--  tip  hover tooltip text (may contain simple HTML such as <br> or <b>)
        return { 99, math.huge, base }
local CONFIG = {
     end
    { list = "melee",           file = "Melee Lifesteal.png", link = "https://deadlock.wiki/Melee_Lifesteal",  tip = "Benefits from melee items" },
     local slot = item["Slot"]
    { list = "movementbased",  file = "Slowing Hex.png",      link = "https://deadlock.wiki/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 = "debuffresist",    file = "Debuff Reducer.png",  link = "https://deadlock.wiki/Debuff_Reducer",   tip = "Debuff duration reduced by Debuff Resist" },
     return {
     { list = "heal",            file = "Healing Booster.png",  link = "https://deadlock.wiki/Healing_Booster",  tip = "Healing amplified by Healing Booster and affected by healing reduction" },
        slot_rank,
     { list = "reactivebarrier", file = "Reactive Barrier.png", link = "https://deadlock.wiki/Reactive_Barrier", tip = "Triggers Reactive Barrier" },
         tonumber(item["Cost"]) or math.huge,
    { list = "dispelmagic",     file = "Dispel Magic.png",     link = "https://deadlock.wiki/Dispel_Magic",    tip = "Effect can be dispelled" },
        mw.ustring.lower(item["Name"] or base),
     { list = "indomitable",    file = "Indomitable.png",      link = "https://deadlock.wiki/Indomitable",      tip = "Disable prevented by Indomitable" },
    }
     { list = "unstoppable",     file = "Unstoppable.png",      link = "https://deadlock.wiki/Unstoppable",      tip = "Disable prevented by Unstoppable" },
end
    { list = "platedarmor",    file = "Plated Armor.png",    link = "https://deadlock.wiki/Plated_Armor",    tip = "On-shot effect prevented by Plated Armor" },
     { list = "summons",        file = "Monster Rounds.png",  link = "https://deadlock.wiki/Monster_Rounds",   tip = "Summons affected by Monster Rounds and Heroic Aura" },
}


local function compare(a, b)
-- Renders one icon: a 24px image linking to `link`. A full URL as the link keeps
    for i = 1, 3 do
-- the anchor title-less so Page Previews / Popups ignores it. The wrapper span
        if a.sort[i] ~= b.sort[i] then return a.sort[i] < b.sort[i] end
-- nudges the icon up 2px to match how the card renders inline icons.
    end
local function icon_img(file, link)
    return false
     return '<span style="position:relative;bottom:2px;">[[File:' .. file .. '|24px|link=' .. link .. ']]</span>'
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
end


-- One full-size hint icon with a tooltip.
local function hint_icon(def)
local function hint_icon(def)
     return '<span class="ability-hint">' .. icon_img(def.file)
     return '<span class="ability-hint">' .. icon_img(def.file, def.link)
         .. '<span class="ability-hint-tip">' .. dictionary.translate(def.label_dict_key) .. '</span></span>'
         .. '<span class="ability-hint-tip">' .. def.tip .. '</span></span>'
end
end


local function manual_icon(m)
-- Renders the interaction icon rail for one ability.
    local cls = 'ability-hint'
--  ability_key  the ability's internal key (AbilityCards .Key)
    local dict_key = STATE_DICT_KEYS.normal
--  ability_num  the ability's slot (1-4); coerced to number
    local partial = false
-- Returns rail HTML, or '' when the ability has no interactions.
    if m.state == 'disabled' then
function p.get_icons(ability_key, ability_num)
        cls = cls .. ' ability-hint--disabled'
     local record = ability_data[ability_key]
        dict_key = STATE_DICT_KEYS.disabled
     if record == nil then return '' end
     elseif m.state == 'partial' then
     local num = tonumber(ability_num)
        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)
     local icons = {}
    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 = {}
 
    local num = tonumber(ability_num)
     for _, def in ipairs(CONFIG) do
     for _, def in ipairs(CONFIG) do
         if AbilityTable.is_member(def.list, ability_key, num) then
         if AbilityTable.is_member(def.list, record, num) then
             local key = mw.ustring.lower(def.file)
             table.insert(icons, hint_icon(def))
            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
 
    for _, m in ipairs(manual) do
        if not placed[mw.ustring.lower(m.file)] then
            table.insert(entries, { file = m.file, html = manual_icon(m) })
         end
         end
     end
     end


     if #entries == 0 then return '' end
     if #icons == 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
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page:

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