Editing Module:Sandbox/Vergir

Jump to navigation Jump to search
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:
-- Renders sortable wikitables of abilities filtered by a named stat.
local p = {};
local heroes_data = mw.loadJsonData("Data:HeroData.json")
local util_module = require('Module:Utilities')
local lang_module = require('Module:Lang')


local Lists    = require("Module:AbilityTable/Lists")
--------------------------------------------------------------------------------
local Notes    = require("Module:AbilityTable/Notes")
-- Internal helpers
local Renderers = require("Module:AbilityTable/ComplexRenderers")
--------------------------------------------------------------------------------
local GameData  = require("Module:GameData")


local p = {}
-- Localized string for a key, falling back to a readable version of `fallback`
-- plus a "missing translation" tooltip.
local function localize(key, fallback)
local result = lang_module.get_string(key)
if (result == "") or (result == nil) then
result = util_module.add_space_before_cap(fallback) .. mw.getCurrentFrame():expandTemplate{title="MissingValveTranslationTooltip"}
end
return result
end
 
-- Raw scaling value of a stat under LevelScaling / SpiritScaling, or nil when
-- the hero has no scaling of that type for that stat.
local function raw_scaling(hero_data, scaling_type, stat)
local scaling = hero_data and hero_data[scaling_type .. "Scaling"]
if (scaling == nil or stat == nil) then return nil end
return scaling[stat]
end


-- ============================================================
-- Mapping from hero name to internal tag name
-- TEST COPY of Module:AbilityTable with the proposed
local TAG_NAME_MAP = {
-- Module:AbilityTable/ComplexRenderers.RenderSpiritScaling inlined below,
["Abrams"] = "Abrams",
-- so the whole change can be previewed from one sandbox module.
["Bebop"] = "Bebop",
-- ============================================================
["Billy"] = "Punkgoat",
["Calico"] = "Nano",
["The Doorman"] = "Doorman",
["Drifter"] = "Drifter",
["Dynamo"] = "Dynamo",
["Apollo"] = "Fencer",
["Graves"] = "Necro",
["Grey Talon"] = "Orion",
["Haze"] = "Haze",
["Holliday"] = "Astro",
["Infernus"] = "Inferno",
["Ivy"] = "Tengu",
["Kelvin"] = "Kelvin",
["Lady Geist"] = "Geist",
["Lash"] = "Lash",
["McGinnis"] = "Engineer",
["Mina"] = "VampireBat",
["Mirage"] = "Mirage",
["Mo & Krill"] = "Digger",
["Paige"] = "Bookworm",
["Paradox"] = "Chrono",
["Celeste"] = "Unicorn",
["Pocket"] = "Synth",
["Rem"] = "Familiar",
["Seven"] = "Gigawatt",
["Shiv"] = "Shiv",
["Silver"] = "Werewolf",
["Silver (Transformed)"] = "Werewolf",
["Sinclair"] = "Magician",
["Venator"] = "Priest",
["Victor"] = "Frank",
["Vindicta"] = "Vindicta",
["Viscous"] = "Viscous",
["Vyper"] = "Viper",
["Warden"] = "Warden",
["Wraith"] = "Wraith",
["Yamato"] = "Yamato",
}


-- ============================================================
--------------------------------------------------------------------------------
-- Spirit scaling helpers
-- Data access, for use by other modules
-- ============================================================
--------------------------------------------------------------------------------


-- Returns the Spirit scaling entry of a prop value, or nil. A prop's Scale is
-- returns the table of a specific item, used by external modules
-- either a single { Value, Type } table or an array of them (a duration that
function p.get_json_item(name)
-- scales with both Spirit and ability duration, for example).
for i,v in pairs(heroes_data) do
local function spirit_scale(v)
if (v["Name"] == name) then
    if type(v) ~= "table" then return nil end
return v
    local scale = v["Scale"]
end
    if type(scale) ~= "table" then return nil end
end
    if scale[1] == nil then
return nil
        if scale["Type"] == "spirit" then return scale end
        return nil
    end
    for _, entry in ipairs(scale) do
        if type(entry) == "table" and entry["Type"] == "spirit" then return entry end
    end
    return nil
end
end


-- Collects the non-zero Spirit scalings of one record layer (the base record
-- Hero table for a hero_* key or an exact English name, or nil.
-- or one upgrade tier) as { key, value, multiply }, ordered the way the
local function hero_by_key_or_name(input)
-- ability card lists its props; props the card does not list come last, in
local hero = heroes_data[input]
-- key order. `labels` is the view's cardprops map (see Module:AbilityTable).
if (hero == nil) then hero = p.get_json_item(input) end
local function spirit_scalings(layer, labels)
return hero
    local out = {}
    for k, v in pairs(layer) do
        if k ~= "Upgrades" and tostring(k):sub(1, 1) ~= "_" then
            local s = spirit_scale(v)
            if s and type(s["Value"]) == "number" and s["Value"] ~= 0 then
                table.insert(out, {
                    key      = k,
                    value    = s["Value"],
                    multiply = s["Multiply"] == true,
                })
            end
        end
    end
    table.sort(out, function(a, b)
        local oa = labels[a.key] and labels[a.key].order or math.huge
        local ob = labels[b.key] and labels[b.key].order or math.huge
        if oa ~= ob then return oa < ob end
        return a.key < b.key
    end)
    return out
end
end


-- Formats a scaling value to 3 significant figures, as the ability cards do.
-- Value of a stat, checking the hero's top level, then Weapon, then AltFire.
local function format_spirit(v)
-- Returns nil when the hero has no such stat.
    return string.format("%.3g", v)
function p.get_stat(hero_data, stat)
if (hero_data == nil or stat == nil) then return nil end
local value = hero_data[stat]
if (value == nil and hero_data.Weapon) then
value = hero_data.Weapon[stat]
end
if (value == nil and hero_data.Weapon and hero_data.Weapon.AltFire) then
value = hero_data.Weapon.AltFire[stat]
end
return value
end
end


-- Formats one Spirit scaling for the table cell through the compact {{Ss}}
-- Ordered list of a hero's scalings for a stat, Level first then Spirit:
-- form, the same way RenderBarrier does. The template is expanded via the
--  { { type = "Level", value = 1.5 }, { type = "Spirit", value = 0.04 } }
-- frame the surrounding #invoke runs under, since module return values are
-- Absent and zero scalings are omitted, so an empty list means "no scaling".
-- not re-expanded; the plain "×N" fallback covers a nil frame (module
function p.get_scalings(hero_data, stat)
-- console).
local scalings = {}
local function format_spirit_badge(v)
for _, scaling_type in ipairs({"Level", "Spirit"}) do
    local text  = format_spirit(v)
local value = raw_scaling(hero_data, scaling_type, stat)
    local frame = mw.getCurrentFrame()
if (value ~= nil and value ~= 0) then
    if frame then
table.insert(scalings, { type = scaling_type, value = value })
        return frame:expandTemplate{
end
            title = "Ss",
end
            args  = { text, compact = "1", show_value = "1" },
return scalings
        }
    end
    return "×" .. text
end
end


-- "A", "A and B", "A, B and C".
-- DEPRECATED, kept for [[Module:HeroComparisonTable]]. Use p.get_scalings.
local function join_names(names)
-- Keyed by scaling value, so it silently drops an entry when Level and Spirit
    if #names <= 1 then return names[1] or "" end
-- scale by the same amount, and it keeps zero scalings.
    return table.concat(names, ", ", 1, #names - 1) .. " and " .. names[#names]
function p.get_hero_scaling_data(hero_data, hero_stat_key)
local scaling_data_returned = {}
for _, scaling_type in ipairs({"Spirit", "Level"}) do
local scaling_value = raw_scaling(hero_data, scaling_type, hero_stat_key)
if (scaling_value ~= nil) then
scaling_data_returned[scaling_value] = scaling_type
end
end
return scaling_data_returned
end
end


-- Renders Spirit Power scaling.
-- Whether a hero has a stat at all: a non-zero base value, or any scaling.
-- Lists every prop that scales with Spirit at base, one per line as an {{Ss}}
function p.has_stat(hero_data, stat)
-- badge labelled with the prop's name from the ability card:
local base = p.get_stat(hero_data, stat)
-- "x0.55 (Base Damage)". Two
if (base ~= nil and base ~= 0) then return true end
-- props sharing a name are told apart by the card's Title
return #p.get_scalings(hero_data, stat) > 0
-- ("Damage: Cost of Stay"); props the card does not list show their raw key.
end
-- Upgrades are reported in Notes per prop, with the running total: additive
-- ones as "adds +×0.5 ... (total ×1.05)", ones that unlock scaling on a prop
-- as "grants ×1.3 ...", and Multiply upgrades as "multiplies ... by 1.15",
-- which is how the ability-upgrade gadget applies them.
function p.RenderSpiritScaling(ability, cardprops)
    local labels = cardprops or {}


    local base  = spirit_scalings(ability, labels)
-- Resolves a hero_* key or an English hero name to a hero_* key.
    local tiers = {}  -- { tier = i, list = ... } in tier order
-- Returns nil when the input matches no hero. Name matching is case-insensitive.
    local upgrades = ability["Upgrades"]
function p.find_hero_key(input)
    if type(upgrades) == "table" then
if (input == nil or input == '') then return nil end
        -- ipairs rather than #: mw.loadJsonData tables have no length.
if (heroes_data[input] ~= nil) then return input end
        for i, tier in ipairs(upgrades) do
local wanted = mw.ustring.lower(input)
            if type(tier) == "table" then
for hero_key, hero_data in pairs(heroes_data) do
                table.insert(tiers, { tier = i, list = spirit_scalings(tier, labels) })
if (hero_data["Name"] and mw.ustring.lower(hero_data["Name"]) == wanted) then
            end
return hero_key
        end
end
    end
end
 
return nil
    -- Names used by more than one scaling prop of this ability get their Title
end
    -- appended so the rows can be told apart.
    local keys_by_name = {}
    local function note_keys(list)
        for _, prop in ipairs(list) do
            local info = labels[prop.key]
            if info then
                keys_by_name[info.name] = keys_by_name[info.name] or {}
                keys_by_name[info.name][prop.key] = true
            end
        end
    end
    note_keys(base)
    for _, t in ipairs(tiers) do note_keys(t.list) end
 
    local function label_of(key)
        local info = labels[key]
        if not info then return key end
        local n = 0
        for _ in pairs(keys_by_name[info.name] or {}) do n = n + 1 end
        if n > 1 and info.title then return info.name .. ": " .. info.title end
        return info.name
    end
 
    local cells  = {}
    local running = {}  -- prop key -> current total scaling
 
    if #base > 0 then
        local lines = {}
        for _, prop in ipairs(base) do
            table.insert(lines, format_spirit_badge(prop.value) .. " (" .. label_of(prop.key) .. ")")
            running[prop.key] = prop.value
        end
        cells["Spirit Scaling"] = table.concat(lines, "<br>")
    end
 
    local notes = {}
    for _, t in ipairs(tiers) do
        local i, list = t.tier, t.list
        local groups, group_order = {}, {}  -- Multiply upgrades, grouped by multiplier
        for _, up in ipairs(list) do
            local label  = label_of(up.key)
            local current = running[up.key]
            if up.multiply then
                local group = groups[up.value]
                if not group then
                    group = { labels = {}, totals = {} }
                    groups[up.value] = group
                    table.insert(group_order, up.value)
                end
                table.insert(group.labels, label)
                if current then
                    running[up.key] = current * up.value
                    table.insert(group.totals, "×" .. format_spirit(running[up.key]))
                else
                    table.insert(group.totals, "?")
                end
            elseif current then
                running[up.key] = current + up.value
                table.insert(notes, "T" .. i .. " upgrade adds +×" .. format_spirit(up.value)
                    .. " " .. label .. " scaling (total ×" .. format_spirit(running[up.key]) .. ")")
            else
                running[up.key] = up.value
                table.insert(notes, "T" .. i .. " upgrade grants ×" .. format_spirit(up.value)
                    .. " " .. label .. " scaling")
            end
        end
        for _, m in ipairs(group_order) do
            local group = groups[m]
            table.insert(notes, "T" .. i .. " upgrade multiplies " .. join_names(group.labels)
                .. " scaling by " .. format_spirit(m)
                .. " (total " .. table.concat(group.totals, ", ") .. ")")
        end
    end


    if #notes > 0 then cells["Notes"] = table.concat(notes, ". ") end
-- A hero's Nth roster tag (1-3) by English name, or '' when there is no such tag.
    return cells
function p.hero_tag(hero_en, index)
local tagname = hero_en and TAG_NAME_MAP[hero_en]
if (tagname == nil) then return '' end
if (index ~= 1 and index ~= 2 and index ~= 3) then return '' end
return lang_module.get_string(string.format("Citadel_%s_HeroTag_%d", tagname, index)) or ''
end
end


-- get_cells(ability, cardprops) -> { [column header] = cell text, Notes = ... }
--------------------------------------------------------------------------------
-- `cardprops` maps the ability's prop keys to their display labels; most
-- Wikitext entry points
-- renderers ignore it.
--------------------------------------------------------------------------------
local extra_columns = {
    ["barrier"] = {
        headers  = { "Barrier" },
        get_cells = Renderers.RenderBarrier,
    },
    ["bossdmgscale"] = {
        headers  = { "Damage to Objectives" },
        get_cells = Renderers.RenderBossDamageScale,
    },
    ["charges"] = {
        headers  = { "Charges", "Time Between Charges", "Notes" },
        get_cells = Renderers.RenderCharges,
    },
    ["melee"] = {
        headers  = { "Base Damage", "Light Melee Scaling", "Notes" },
        get_cells = Renderers.RenderMelee,
    },
    ["heavymelee"] = {
        headers  = { "Base Damage", "Heavy Melee Scaling", "Notes" },
        get_cells = Renderers.RenderHeavyMelee,
    },
    ["scalingspirit"] = {
        headers  = { "Spirit Scaling", "Notes" },
        get_cells = p.RenderSpiritScaling,  -- TEST: inlined copy above
    },
    ["healreduce"] = {
        headers  = { "Heal Reduction", "Notes" },
        get_cells = Renderers.RenderHealReduce,
    },
    ["moveslow"] = {
        headers  = { "Move Slow", "Notes" },
        get_cells = Renderers.RenderMoveSlow,
    },
    ["dashslow"] = {
        headers  = { "Dash Slow", "Notes" },
        get_cells = Renderers.RenderDashSlow,
    },
    ["extradebuffresist"] = {
        headers  = { "Debuff Resist" },
        get_cells = Renderers.RenderExtraDebuffResist,
    },
}
 
-- ============================================================
-- Note enrichment
-- ============================================================


-- Merges auto-generated and human notes for full-table mode.
-- returns the key of the specified hero's english name
-- Capitalizes human note, joins with ". ", ensures trailing period.
function p.get_hero_key(frame)
local function enrich_notes_full(extra, human_note)
local hero_name_input = frame.args[1]
    if human_note then
if not hero_name_input then
        human_note = human_note:sub(1,1):upper() .. human_note:sub(2)
return "Error: Hero name not specified."
        extra["Notes"] = extra["Notes"] and (extra["Notes"] .. ". " .. human_note) or human_note
end
    end
return p.find_hero_key(hero_name_input) or "Hero not found."
    if extra["Notes"] and extra["Notes"]:sub(-1) ~= "." then
        extra["Notes"] = extra["Notes"] .. "."
    end
end
end


-- Merges auto-generated and human notes for compact mode.
--{{#invoke:HeroData|resolve_key|HERO_KEY_OR_NAME}}--
-- Decapitalizes human note (skips T{N} prefixes like "T1 slow"),
-- The matching hero_* key, or '' when the input matches no hero.
-- joins with "; ", strips trailing period.
function p.resolve_key(frame)
local function enrich_notes_compact(extra, human_note)
return p.find_hero_key(frame.args[1]) or ''
    if human_note then
        local first = human_note:sub(1,1)
        if first:match("%u") and not human_note:sub(2,2):match("%d") then
            human_note = first:lower() .. human_note:sub(2)
        end
        if human_note:sub(-1) == "." then human_note = human_note:sub(1, -2) end
        extra["Notes"] = extra["Notes"] and (extra["Notes"] .. "; " .. human_note) or human_note
    end
end
end


-- ============================================================
--{{#invoke:HeroData|get_hero_var|HERO_NAME|STAT_NAME|sig_figs_or_localize}}--
-- Ability views
--sig_figs optional for rounding floats
--
p.get_hero_var = function(frame)
-- In-game Ability may containe 1 or more records in AbilityData.json
     local hero_name = frame.args[1]
-- Example: Vexing Bolt is 2 records (Launch Bolt + Redirect Bolt).
     local hero_stat_key = frame.args[2]
 
    local sig_figs_or_localize = frame.args[3]
-- "Ability View" is a main-record + any relevant sub-ability records.
   
-- Each view entry also carries "cardprops", the display labels of the
    local hero = hero_by_key_or_name(hero_name)
-- ability's props taken from its card (see card_prop_labels). They are kept
    if(hero == nil) then return "Hero Not Found" end
-- beside the record rather than inside it so that membership matching, which
   
-- walks the whole record, never sees them.
    local var_value = p.get_stat(hero, hero_stat_key)
-- ============================================================
    if(var_value == nil) then return 0 end
 
   
-- Display labels for a card's props: prop key -> { name, title, order }, read
    --round
-- from the Info sections of the card in AbilityCards.json. The flat
    if (sig_figs_or_localize ~= nil and tonumber(sig_figs_or_localize) ~= nil) then
-- AbilityData records carry no display names, and a key such as "Damage" is
        var_value = util_module.round_to_sig_fig(var_value, sig_figs_or_localize)
-- reused across abilities under different labels, so the map is built per
        if (var_value == nil) then return "get_hero_var() error with rounding" end
-- card rather than wiki-wide. `order` is the position of the prop on the
-- card, so renderers can list props the way the in-game card does.
local function card_prop_labels(card)
     local labels, n = {}, 0
 
     local function walk(node)
        if type(node) ~= "table" then return end
        local key, name = node["Key"], node["Name"]
        if type(key) == "string" and type(name) == "string" and not labels[key] then
            n = n + 1
            local title = node["Title"]
            if type(title) == "string" then
                title = title:gsub(":%s*$", "")
            else
                title = nil
            end
            labels[key] = { name = name, title = title, order = n }
        end
        if node[1] ~= nil then
            for _, child in ipairs(node) do walk(child) end
        else
            -- Sections such as Range or Move key each prop by its name:
            -- { AttackDashRange = { Name = "...", Value = ... } }.
            local keyed = {}
            for k, v in pairs(node) do
                if type(k) == "string" and type(v) == "table" and v["Key"] == nil
                    and type(v["Name"]) == "string" and not labels[k]
                then
                    table.insert(keyed, k)
                end
            end
            table.sort(keyed)
            for _, k in ipairs(keyed) do
                n = n + 1
                labels[k] = { name = node[k]["Name"], order = n }
            end
            -- Main props before Alt props, then anything else in key order.
            if node["Main"] ~= nil then walk(node["Main"]) end
            if node["Alt"]  ~= nil then walk(node["Alt"])  end
            local rest = {}
            for k, v in pairs(node) do
                if k ~= "Main" and k ~= "Alt" and k ~= "Upgrades" and type(v) == "table" then
                    table.insert(rest, k)
                end
            end
            table.sort(rest, function(a, b) return tostring(a) < tostring(b) end)
            for _, k in ipairs(rest) do walk(node[k]) end
        end
    end
 
    for _, section in ipairs({ "Info1", "Info2", "Info3" }) do
        walk(card[section])
    end
    local rest = {}
    for k, v in pairs(card) do
        if type(v) == "table" and k ~= "Upgrades"
            and k ~= "Info1" and k ~= "Info2" and k ~= "Info3"
        then
            table.insert(rest, k)
        end
     end
     end
     table.sort(rest, function(a, b) return tostring(a) < tostring(b) end)
      
    for _, k in ipairs(rest) do walk(card[k]) end
     --localize
 
     if (sig_figs_or_localize == "true") then
     -- Header attributes are stored on the card without a Name.
         return lang_module.get_string(var_value)
     local header_attrs = {
        { "AbilityCastRange",            "Cast Range" },
         { "Radius",                      "Radius" },
        { "AbilityDuration",            "Duration" },
        { "AbilityChannelTime",          "Channel Time" },
        { "AbilityCooldown",            "Cooldown" },
        { "AbilityCharges",              "Charges" },
        { "AbilityCooldownBetweenCharge", "Charge Cooldown" },
    }
    for _, attr in ipairs(header_attrs) do
        if not labels[attr[1]] then
            n = n + 1
            labels[attr[1]] = { name = attr[2], order = n }
        end
     end
     end


     return labels
     return var_value
end
end


local _views = nil  -- card key -> { view = record, heroName = ..., abilityNum = ..., cardprops = ... }
--{{#invoke:HeroData|get_alt_fire_var|HERO_NAME|STAT_NAME|sig_figs_or_localize}}--
local _order = nil  -- array of card keys, sorted by hero then slot
p.get_alt_fire_var = function(frame)
 
     local hero_name = frame.args[1]
local function build_views()
     local stat_key = frame.args[2]
     if _views then return _views, _order end
     local sig_figs_or_localize = frame.args[3]
    _views, _order = {}, {}
      
 
    local hero = hero_by_key_or_name(hero_name)
     local hero_data = mw.loadJsonData("Data:HeroData.json")
    if(hero == nil) then return "Hero Not Found" end
     local active_heroes = {}
      
     for _, hero in pairs(hero_data) do
     if not (hero.Weapon and hero.Weapon.AltFire) then
        if type(hero) == "table"
         return "No Alt Fire"
            and hero["IsDisabled"] == false
            and type(hero["Name"]) == "string"
            and (hero["IsSelectable"] == nil or hero["IsSelectable"] ~= false)
        then
            active_heroes[hero["Name"]] = true
        end
     end
 
     local ability_data = mw.loadJsonData(GameData.Dataset.ABILITIES)
    local cards        = mw.loadJsonData("Data:AbilityCards.json")
 
    local card_of = {}
    for _, hero_entry in pairs(cards) do
         if type(hero_entry) == "table" then
            local hero_name = hero_entry["Name"]
            if hero_name and active_heroes[hero_name] then
                for slot_str, ability in pairs(hero_entry) do
                    local slot_num = tonumber(slot_str)
                    local key = type(ability) == "table" and ability["Key"] or nil
                    if slot_num and key and ability_data[key] then
                        card_of[key] = { heroName = hero_name, abilityNum = slot_num, card = ability }
                    end
                end
            end
        end
     end
     end
 
      
     -- Attach each non-card record to the longest card key it prefixes.
     local var_value = hero.Weapon.AltFire[stat_key]
     local subs = {}
     if(var_value == nil) then return 0 end
     for key, record in pairs(ability_data) do
   
        if not card_of[key] and record["IsDisabled"] ~= true then
    --round
            local parent = nil
    if (sig_figs_or_localize ~= nil and tonumber(sig_figs_or_localize) ~= nil) then
            for card_key in pairs(card_of) do
        var_value = util_module.round_to_sig_fig(var_value, sig_figs_or_localize)
                if key:sub(1, #card_key + 1) == card_key .. "_"
                    and (parent == nil or #card_key > #parent)
                then
                    parent = card_key
                end
            end
            if parent then
                subs[parent] = subs[parent] or {}
                table.insert(subs[parent], record)
            end
        end
     end
     end
 
   
     for key, info in pairs(card_of) do
    --localize
        local view = {}
     if (sig_figs_or_localize == "true") then
        for k, v in pairs(ability_data[key]) do view[k] = v end
         return lang_module.get_string(var_value)
        view["_subabilities"] = subs[key]
        _views[key] = {
            view      = view,
            heroName  = info.heroName,
            abilityNum = info.abilityNum,
            cardprops  = card_prop_labels(info.card),
        }
         table.insert(_order, key)
     end
     end


     table.sort(_order, function(a, b)
     return var_value
        local ia, ib = _views[a], _views[b]
end
        if ia.heroName ~= ib.heroName then return ia.heroName < ib.heroName end
        return ia.abilityNum < ib.abilityNum
    end)


    return _views, _order
--{{#invoke:HeroData|get_list_elem|HERO_NAME|VAR|NUMBER|LOCALIZE}}
p.get_list_elem = function(frame)
local hero_name = frame.args[1]
local var = frame.args[2]
local number_int = tonumber(frame.args[3])
local localize_arg = frame.args[4]
local hero = hero_by_key_or_name(hero_name)
if(hero == nil) then return "Hero Not Found" end
local list = p.get_stat(hero, var)
if (list == nil) then return "" end
local element = list[number_int]
if (element == nil) then return "" end
if localize_arg=="true" then
element = lang_module.get_string(element)
end
return element
end
end


-- ============================================================
p.get_ability_key = function(frame)
-- Membership
local hero_key = frame.args[1]
-- Pieces of code that help in telling  "is ability X a member of list Y".
local bound_slot_number = frame.args[2]
-- main function is: p.is_member()
local hero_data = heroes_data[hero_key]
-- ============================================================
if (hero_data == nil) then return "Hero key "..hero_key.. " not found" end
local bound_abilities_data = hero_data["BoundAbilities"]
if (bound_abilities_data == nil) then return "Hero key " .. hero_key.. " has no BoundAbilities" end
return bound_abilities_data[tonumber(bound_slot_number)]["Key"]
end


-- Memoized name-exclusion set per list (from Lists.exclude_abilities).
p.write_role_playstyle_quote = function(frame)
local _excluded = {}
local hero_key = frame.args[1]
local function excluded_set(stat)
local hero_data = heroes_data[hero_key]
    if _excluded[stat] then return _excluded[stat] end
if (hero_data == nil) then return hero_key.." not found" end
    local set = {}
local role_key = hero_data["Role"]
    for _, name in ipairs(Lists.exclude_abilities[stat] or {}) do
local role_localized = lang_module.get_string(role_key, nil, 'en')
        set[name] = true
local playstyle_key = hero_data["Playstyle"]
    end
local playstyle_localized = lang_module.get_string(playstyle_key, nil, 'en')
    _excluded[stat] = set
    return set
local str = "<b>" .. role_localized .. '</b><br>' .. playstyle_localized
local template_args = {}
template_args[1] = ""
template_args[2] = str
return frame:expandTemplate{title = 'Quotation', args = template_args}
end
end


-- Per-list rules that can't be expressed as prop lists or exclusions.
p.write_default_items = function(frame)
-- Returns true to keep the ability, false to drop it.
local hero_key = frame.args[1] --unlocalized
local function special_ok(stat, record, ability_num)
if (hero_key == nil) then return "No hero key provided" end
    if stat == "dispelmagic" and ability_num == 4 then return false end
local str = ""
    return true
local hero = heroes_data[hero_key]
if (hero == nil) then return "Hero not found, must be unlocalized" end
local template_title = 'PageRef'
for i, item_key in ipairs(hero["RecommendedItems"] or {}) do
local template_args = {}
template_args[1] = lang_module.get_string(item_key, 'en')
template_args['alt_name'] = localize(item_key, item_key)
local expanded_template = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
str = str .. "* " .. expanded_template .. "\n"
end
return str
end
end


-- Public: does ability `ability_key` belong to list `stat`?
--If the hero scales with the stat, it returns {{Ss|value}} or {{Ls|value}}, else blank string
function p.is_member(stat, ability_key, ability_num)
--{{#invoke:HeroData|get_hero_scalar|HERO_NAME|SCALING_TYPE|STAT_NAME|sig_figs_or_localize}}--
    local props = Lists.lists[stat]
p.get_hero_scalar = function(frame)
    if not props then return false end
local hero_key = frame.args[1]
local scaling_type = frame.args[2]
local hero_stat_key = frame.args[3]
local sig_figs_or_localize = frame.args[4]
local no_template = frame.args["no_template"]
local hero_data = hero_by_key_or_name(hero_key)
if(hero_data == nil) then return "Hero not found." end
local scaling_value = raw_scaling(hero_data, scaling_type, hero_stat_key)
if scaling_value == nil then return "" end


    local views = build_views()
--round
    local entry = views[ability_key]
if (sig_figs_or_localize ~= nil and tonumber(sig_figs_or_localize) ~= nil) then
    local view  = entry and entry.view
scaling_value = util_module.round_to_sig_fig(scaling_value, sig_figs_or_localize)
 
if (scaling_value == nil) then return "get_hero_scalar() error with rounding" end
    if not view then
end
        view = mw.loadJsonData(GameData.Dataset.ABILITIES)[ability_key]
        if not view then return false end
--localize
    end
if (sig_figs_or_localize == "true") then
 
return lang_module.get_string(scaling_value)
    local name = view["Name"]
end
    if name and excluded_set(stat)[name] then return false end
 
if no_template == "true" then
    ability_num = ability_num or (entry and entry.abilityNum)
return scaling_value
    if not special_ok(stat, view, ability_num) then return false end
end
return p.write_scalar_str(scaling_value, scaling_type)
end


    return GameData.entity_matches(view, props)
-- Check if a hero has a stat (Base, Boons, or Spirit Scaling)
-- Returns "true" if found, nil if not (for #if templates)
p.hero_has_stat = function(frame)
local hero_key = frame.args[1]
local stat_key = frame.args[2]
if (hero_key == nil) then return nil end
local hero_data = hero_by_key_or_name(hero_key)
if (hero_data == nil) then return nil end
if p.has_stat(hero_data, stat_key) then return "true" end
return nil
end
end


-- ============================================================
-- Function to call hero tags based on name
-- Entry point
p.get_hero_tag = function (frame)
-- ============================================================
local name = frame.args[1]
local number = tonumber(frame.args[2])


function p.render(frame)
-- Validate input
    local stat = mw.text.trim(frame.args[1] or ""):lower()
if not name then
return "Error: Missing name input."
end


    local internal_keys = Lists.lists[stat]
if number ~= 1 and number ~= 2 and number ~= 3 then
    if not internal_keys then
return string.format("Error: Invalid number '%s'. Must be 1, 2, or 3.", tostring(frame.args[2]))
        return '<span class="error">AbilityTable: unknown list "' .. stat .. '".</span>'
end
    end


    local hide_set = {}
if TAG_NAME_MAP[name] == nil then
    local hide_param = mw.text.trim(frame.args["hide"] or "")
return string.format("Error: Unknown name '%s'.", name)
    if hide_param ~= "" then
end
        for col in hide_param:gmatch("[^,]+") do hide_set[mw.text.trim(col)] = true end
    end


    local compact = mw.text.trim(frame.args["compact"] or "") ~= ""
return p.hero_tag(name, number)
end


    local collapsed = mw.text.trim(frame.args["collapsed"] or ""):lower()
--{{#invoke:HeroData|has_tags|HERO_ENGLISH_NAME}}--
-- 'true' when the hero has roster tags, '' otherwise.
function p.has_tags(frame)
if p.hero_tag(frame.args[1], 1) ~= '' then return 'true' end
return ''
end


    local views, order = build_views()
-- Retrieve scaling string of a hero's given stat, if it has scaling, else return blank
    local spec      = extra_columns[stat]
-- Scaling string meaning the expanded template {{Ss|scalar}} or {{Ls|scalar}}
    local headers    = spec and spec.headers or {}
function p.write_scalar_str(scaling_value, scaling_type, compact)
    local get_cells  = spec and spec.get_cells or function() return {} end
local scaling_abbrevs = {Spirit = "Ss", Level = "PI"}
     local stat_notes = Notes[stat]
-- Return blank if it doesnt scale
if (scaling_value == 0) then return "" end
-- Round it
scaling_value = util_module.round_to_sig_fig(scaling_value, 3)
--The hero has a scaling value with this stat
local template_title = "Template:" .. scaling_abbrevs[scaling_type]
local template_args = {}
template_args["1"] = scaling_value
if compact then
template_args["compact"] = "yes"
template_args["show_value"] = "yes"
end
local template_call = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
      
return template_call:gsub("\n", ""):gsub("\r", "")
end


    local filtered = {}
-- Outputs a wikitable of heroes grouped by GroundDashDuration using {{HeroIcon|hero_name}}
    for _, key in ipairs(order) do
-- {{#invoke:HeroData|write_ground_dash_buckets}}
        if p.is_member(stat, key) then
p.write_ground_dash_buckets = function(frame)
            table.insert(filtered, key)
     local buckets = {
        end
         [0.62] = {},
    end
         [0.68] = {},
 
         [0.72] = {},
    if #filtered == 0 then
     }
        return "No abilities found for list: " .. stat
    end
 
    local lists_url = mw.uri.fullUrl("Module:AbilityTable/Lists")
     local notes_url = mw.uri.fullUrl("Module:AbilityTable/Notes", { action = "edit" })
    local disclaimer = frame:preprocess(
        '<div class="ability-table-disclaimer">'
         .. 'This is a dynamic list '
        .. '<span class="ability-table-list-name">"' .. stat .. '"</span>. '
         .. '[' .. tostring(lists_url) .. ' Edit contents]'
        .. ' · '
         .. '[' .. tostring(notes_url) .. ' Edit notes].'
        .. '</div>'
     )


     if compact then
     -- Collect heroes
        local hero_order     = {}
     for hero_key, hero_data in pairs(heroes_data) do
        local hero_abilities = {}
        if not hero_data.InDevelopment and not hero_data.IsDisabled then
        for _, key in ipairs(filtered) do
             local dash = p.get_stat(hero_data, "GroundDashDuration")
             local hero = views[key].heroName
             if dash and buckets[dash] then
             if not hero_abilities[hero] then
                 table.insert(buckets[dash], hero_data.Name or hero_key)
                 table.insert(hero_order, hero)
                hero_abilities[hero] = {}
             end
             end
            table.insert(hero_abilities[hero], views[key])
        end
        local items = {}
        for _, hero in ipairs(hero_order) do
            local hero_cell = frame:expandTemplate{ title = "HeroIcon", args = { hero } }
            local ability_parts = {}
            for _, entry in ipairs(hero_abilities[hero]) do
                local ability = entry.view
                local name = ability["Name"]
                local ability_cell = frame:expandTemplate{ title = "AbilityIcon", args = { name } }
                local extra = get_cells(ability, entry.cardprops)
                enrich_notes_compact(extra, stat_notes and stat_notes[name])
                local note = extra["Notes"]
                if note then
                    table.insert(ability_parts, ability_cell .. " (" .. note .. ")")
                else
                    table.insert(ability_parts, ability_cell)
                end
            end
            table.insert(items, "<li>" .. hero_cell .. ": " .. table.concat(ability_parts, ", ") .. "</li>")
        end
        return disclaimer .. "<ul>" .. table.concat(items) .. "</ul>"
    end
    local has_notes_header = false
    local final_headers = {}
    for _, h in ipairs(headers) do
        if h == "Notes" then
            has_notes_header = true
        elseif not hide_set[h] then
            table.insert(final_headers, h)
         end
         end
     end
     end
    local needs_notes = (has_notes_header or stat_notes ~= nil) and not hide_set["Notes"]
    if needs_notes then table.insert(final_headers, "Notes") end


     local table_class = 'wikitable sortable ability-table'
     -- Sort alphabetically
     if collapsed ~= "" then
     for _, list in pairs(buckets) do
         table_class = table_class .. ' mw-collapsible'
         table.sort(list)
        if collapsed == "yes" or collapsed == "true" or collapsed == "1" then
            table_class = table_class .. ' mw-collapsed'
        end
     end
     end


     local out = {}
     -- Determine max rows dynamically
    table.insert(out, disclaimer)
     local max_rows = 0
    table.insert(out, '{| class="' .. table_class .. '"')
     for _, list in pairs(buckets) do
 
         if #list > max_rows then max_rows = #list end
     local header_row = '! class="ability-table-col-hero" | Hero'
                    .. ' !! class="ability-table-col-ability" | Ability'
     for _, h in ipairs(final_headers) do
         header_row = header_row .. ' !! class="ability-table-col-'
            .. h:lower():gsub("%s+", "-") .. '" | ' .. h
     end
     end
    table.insert(out, header_row)
        local hero_counts = {}
    for _, key in ipairs(filtered) do
        local hero = views[key].heroName
        hero_counts[hero] = (hero_counts[hero] or 0) + 1
    end
    local hero_seen = {}
    for _, key in ipairs(filtered) do
        local entry  = views[key]
        local ability = entry.view
        local hero    = entry.heroName
        local ability_cell = frame:expandTemplate{
            title = "AbilityIcon",
            args = { ability["Name"] }
        }
        local extra = get_cells(ability, entry.cardprops)
        enrich_notes_full(extra, stat_notes and stat_notes[ability["Name"]])
        local row
        if not hero_seen[hero] then
            local hero_cell = frame:expandTemplate{
                title = "HeroIcon",
                args = { hero }
            }
            if hero_counts[hero] > 1 then
                row = '| rowspan="' .. hero_counts[hero] .. '" class="ability-table-cell-hero" | '
                    .. hero_cell
                    .. ' || class="ability-table-cell-ability" | ' .. ability_cell
            else
                row = '| class="ability-table-cell-hero" | '
                    .. hero_cell
                    .. ' || class="ability-table-cell-ability" | ' .. ability_cell
            end


            hero_seen[hero] = true
    local output = {"{| class='wikitable mw-collapsible'",
        else
    "|+Hero Dash Buckets", "! Bucket 1 !! Bucket 2 !! Bucket 3"}
            row = '| class="ability-table-cell-ability" | ' .. ability_cell
    local current_frame = frame or mw.getCurrentFrame()
        end


         for _, header in ipairs(final_headers) do
    for i = 1, max_rows do
             local value = extra[header]
        local row = {}
             local cls  = "ability-table-cell-" .. header:lower():gsub("%s+", "-")
         for _, bucket in ipairs({0.62, 0.68, 0.72}) do
            local content = value ~= nil and tostring(value) or "—"
             local hero_name = buckets[bucket][i]
            row = row .. ' || class="' .. cls .. '" | ' .. content
             table.insert(row, hero_name and current_frame:expandTemplate{title = "HeroIcon", args = {hero_name}} or "")
         end
         end
 
         table.insert(output, "|-\n| " .. table.concat(row, " || "))
         table.insert(out, "|-")
        table.insert(out, row)
     end
     end


     table.insert(out, "|}")
     table.insert(output, "|}")
     return table.concat(out, "\n")
     return table.concat(output, "\n")
end
end
-- TEST ONLY: plain-text dump of a list for review, one line per ability.
function p.dump(frame)
    local stat = mw.text.trim(frame.args[1] or ""):lower()
    local views, order = build_views()
    local spec = extra_columns[stat]
    local get_cells = spec and spec.get_cells or function() return {} end
    local out = {}
    for _, key in ipairs(order) do
        if p.is_member(stat, key) then
            local entry = views[key]
            local extra = get_cells(entry.view, entry.cardprops)
            local cell = extra["Spirit Scaling"] or "—"
            cell = mw.text.killMarkers(cell):gsub("<br>", " / "):gsub("<[^>]+>", "")
            table.insert(out, entry.heroName .. " | " .. entry.view["Name"] .. " | " .. cell .. " | " .. (extra["Notes"] or "—"))
        end
    end
    return "<pre>" .. mw.text.nowiki(table.concat(out, "\n")) .. "</pre>"
end
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

Page included on this page:

Retrieved from "https://deadlock.wiki/Module:Sandbox/Vergir"