Editing Module:AbilityTableGive feedback
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. | -- Renders sortable wikitables of abilities filtered by a named stat. | ||
local | -- Maps lowercase friendly stat names to internal AbilityData property keys or values. | ||
local stat_to_props = { | |||
["charges"] = { "AbilityCharges" }, | |||
["melee"] = { "melee", "heavy_melee" }, | |||
["wpndmg"] = { "melee", "heavy_melee", "weapon_damage_increase" }, | |||
["healreduce"] = { "HealAmpReceivePenaltyPercent", "HealAmpRegenPenaltyPercent", "DisableHealing" }, | |||
} | |||
local | -- Editor-authored notes appended to the Notes column. | ||
local human_notes = { | |||
["charges"] = { | ["charges"] = { | ||
["Jar of Dead"] = "Charges by being near when anything dies.", | |||
}, | }, | ||
["melee"] = { | ["melee"] = { | ||
["Puddle Punch"] = "Can be parried.", | |||
}, | }, | ||
} | } | ||
-- Unit strings appended to cell values by column name. | |||
local column_suffix = { | |||
["Time Between Charges"] = "s", | |||
["Duration"] = "s", | |||
} | |||
-- Actual code below | |||
local p = {} | |||
local GameData = require("Module:GameData") | |||
-- ============================================================ | -- ============================================================ | ||
-- | -- Shared helpers | ||
-- ============================================================ | -- ============================================================ | ||
local function num_val(v) | |||
if type(v) == "number" then return v end | |||
local function | if type(v) == "table" then return v["Value"] end | ||
if | return nil | ||
if | |||
end | end | ||
-- | -- Searches Upgrades[] for a field and returns { tier = N, value = V } at its | ||
-- first appearance, or nil if the field is absent from all upgrade tiers. | |||
-- | local function find_in_upgrades(ability, field) | ||
local function | local upgrades = ability["Upgrades"] | ||
if | if type(upgrades) ~= "table" then return nil end | ||
for i, tier in ipairs(upgrades) do | |||
if | if type(tier) == "table" and tier[field] ~= nil then | ||
return { tier = i, value = num_val(tier[field]) } | |||
end | end | ||
end | end | ||
return nil | |||
end | end | ||
-- ============================================================ | -- ============================================================ | ||
-- | -- Per-stat cell renderers | ||
-- | -- Each function receives a guaranteed-matching ability record | ||
-- | -- and returns { ["Column Name"] = value }. | ||
-- | -- Human notes are appended by the framework, not here. | ||
-- ============================================================ | |||
local function charges_cells(ability) | |||
local base_charges = num_val(ability["AbilityCharges"]) | |||
local base_cooldown = ability["AbilityCooldownBetweenCharge"] | |||
local has_base = base_charges ~= nil and base_charges > 0 | |||
local upgrade_info = find_in_upgrades(ability, "AbilityCharges") | |||
local cooldown, upgrade_cooldown | |||
if has_base then | |||
if type(base_cooldown) == "number" and base_cooldown > 0 then | |||
cooldown = base_cooldown | |||
else | |||
local cd = find_in_upgrades(ability, "AbilityCooldownBetweenCharge") | |||
if cd and cd.value and cd.value > 0 then cooldown = cd.value end | |||
end | |||
else | |||
local cd = find_in_upgrades(ability, "AbilityCooldownBetweenCharge") | |||
if cd and cd.value and cd.value > 0 then upgrade_cooldown = cd.value end | |||
end | |||
local | local cells = {} | ||
if has_base then | |||
cells["Charges"] = tostring(base_charges) | |||
if cooldown then | |||
cells["Time Between Charges"] = tostring(cooldown) | |||
end | |||
end | |||
local | local note_parts = {} | ||
if upgrade_info then | |||
local n = upgrade_info.value or "?" | |||
if | local charge_str = n .. " charge" .. (n ~= 1 and "s" or "") | ||
if has_base then | |||
and | table.insert(note_parts, "+" .. charge_str .. " on T" .. upgrade_info.tier .. " upgrade.") | ||
else | |||
local cd_str = upgrade_cooldown and (upgrade_cooldown .. "s") or "unknown" | |||
table.insert(note_parts, "Becomes charged on T" .. upgrade_info.tier | |||
.. " upgrade with " .. charge_str | |||
.. " and " .. cd_str .. " time between charges.") | |||
end | end | ||
end | |||
if ability["AbilityChargesConditionally"] ~= nil then | |||
table.insert(note_parts, "Has a conditional charge.") | |||
end | |||
if #note_parts > 0 then | |||
cells["Notes"] = table.concat(note_parts, " ") | |||
end | end | ||
return cells | |||
end | |||
-- Finds the base light melee scale value: the first top-level property | |||
for _, | -- whose Scale.Type is "melee" and whose scale value is > 0. | ||
if type( | local function find_base_melee_scale(ability) | ||
local | for _, v in pairs(ability) do | ||
if | if type(v) == "table" then | ||
local scale = v["Scale"] | |||
if type(scale) == "table" | |||
and scale["Type"] == "melee" | |||
and type(scale["Value"]) == "number" | |||
and scale["Value"] > 0 | |||
then | |||
return scale["Value"] | |||
end | end | ||
end | end | ||
end | end | ||
return nil | |||
end | |||
-- Scans all upgrade tiers for melee-scale changes. Upgrade objects are | |||
-- additive in the engine, so the final scale = base + upgrade delta. | |||
-- Returns a list of note strings, one per relevant upgrade tier found. | |||
-- Handles two cases: | |||
-- heavy_melee scale > 0 introduced → ability gains heavy melee scaling | |||
-- melee scale changed (delta ~= 0) → existing melee scaling is modified | |||
local function build_melee_upgrade_notes(ability, base_melee_scale) | |||
local upgrades = ability["Upgrades"] | |||
if type(upgrades) ~= "table" then return {} end | |||
local notes = {} | |||
for i, tier in ipairs(upgrades) do | |||
if type(tier) == "table" then | |||
for _, v in pairs(tier) do | |||
if type(v) == "table" then | |||
local scale = v["Scale"] | |||
if type(scale) == "table" and type(scale["Value"]) == "number" then | |||
local stype = scale["Type"] | |||
local delta = scale["Value"] | |||
if stype == "heavy_melee" and delta > 0 then | |||
-- Introduces heavy melee scaling (additive on top of zeroed melee) | |||
table.insert(notes, "T" .. i .. " upgrade changes scaling to ×" | |||
.. delta .. " of '''[[Heavy Melee]]''' damage.") | |||
elseif stype == "melee" and delta ~= 0 and base_melee_scale then | |||
-- Modifies existing melee scaling additively | |||
local final = base_melee_scale + delta | |||
-- Round to avoid float noise (e.g. 1.2 + 0.4 = 1.5999...) | |||
final = math.floor(final * 1000 + 0.5) / 1000 | |||
table.insert(notes, "T" .. i .. " upgrade adds ×" | |||
.. delta .. " scaling (total ×" .. final .. ").") | |||
end | |||
end | |||
end | end | ||
end | end | ||
end | end | ||
end | end | ||
return notes | |||
end | |||
local function melee_cells(ability) | |||
local cells = {} | |||
local base_scale = find_base_melee_scale(ability) | |||
if base_scale then | |||
cells["Light Melee Scaling"] = "×" .. base_scale | |||
end | end | ||
local upgrade_notes = build_melee_upgrade_notes(ability, base_scale) | |||
if #upgrade_notes > 0 then | |||
cells["Notes"] = table.concat(upgrade_notes, " ") | |||
end | |||
end | |||
return | return cells | ||
end | end | ||
-- | -- Returns the base heal reduction percent (always positive, e.g. 33 for -33%), | ||
-- | -- or nil if the reduction only appears in upgrades. | ||
-- | -- Also returns true if the ability fully disables healing (DisableHealing). | ||
local function find_base_heal_reduce(ability) | |||
local pct = num_val(ability["HealAmpReceivePenaltyPercent"]) | |||
or num_val(ability["HealAmpRegenPenaltyPercent"]) | |||
if pct and pct ~= 0 then | |||
return math.abs(pct), false | |||
end | |||
if ability["DisableHealing"] and ability["DisableHealing"] ~= 0 then | |||
return nil, true | |||
end | |||
return nil, false | |||
end | |||
-- | -- Returns the base duration value using priority: VenomDuration > DebuffDuration > AbilityDuration. | ||
-- Also returns the field name that was found (for upgrade scanning). | |||
local function | local function find_base_duration(ability) | ||
for _, field in ipairs({ "VenomDuration", "DebuffDuration", "AbilityDuration", "BurnDuration" }) do | |||
local v = num_val(ability[field]) | |||
for _, | if v and v > 0 then | ||
return v, field | |||
end | |||
end | end | ||
return nil, nil | |||
return | |||
end | end | ||
-- | local function healreduce_cells(ability) | ||
-- | local cells = {} | ||
local | local notes = {} | ||
return | local base_pct, is_disable = find_base_heal_reduce(ability) | ||
local base_dur, dur_field = find_base_duration(ability) | |||
-- Heal Reduction % column | |||
if is_disable then | |||
cells["Heal Reduction"] = "100% (suppressed)" | |||
elseif base_pct then | |||
cells["Heal Reduction"] = tostring(base_pct) .. "%" | |||
end | |||
-- (if neither, it's upgrade-only — cell stays nil → "—") | |||
-- Duration column | |||
if base_dur then | |||
cells["Duration"] = tostring(base_dur) | |||
end | |||
-- Scan upgrades for changes to heal reduction or duration | |||
local upgrades = ability["Upgrades"] | |||
if type(upgrades) == "table" then | |||
local running_pct = base_pct -- track cumulative percent for additive deltas | |||
local running_dur = base_dur | |||
for i, tier in ipairs(upgrades) do | |||
if type(tier) == "table" then | |||
local tier_notes = {} | |||
-- Heal reduction changes | |||
local pct_delta = num_val(tier["HealAmpReceivePenaltyPercent"]) | |||
or num_val(tier["HealAmpRegenPenaltyPercent"]) | |||
local disable = tier["DisableHealing"] | |||
if disable and disable ~= 0 then | |||
table.insert(tier_notes, "T" .. i .. " upgrade fully suppresses [[Healing]].") | |||
elseif pct_delta and pct_delta ~= 0 then | |||
local delta_abs = math.abs(pct_delta) | |||
if running_pct then | |||
-- Additive change to existing base | |||
local total = running_pct + delta_abs | |||
table.insert(tier_notes, "T" .. i .. " upgrade increases heal reduction by " | |||
.. delta_abs .. "% (total " .. total .. "%).") | |||
running_pct = total | |||
else | |||
-- Introduces heal reduction for the first time | |||
table.insert(tier_notes, "T" .. i .. " upgrade adds " | |||
.. delta_abs .. "% [[Healing Reduction]].") | |||
running_pct = delta_abs | |||
end | |||
end | |||
-- Duration changes (additive deltas in the engine) | |||
if dur_field then | |||
local dur_delta = num_val(tier[dur_field]) | |||
if dur_delta and dur_delta ~= 0 then | |||
if running_dur then | |||
local total_dur = running_dur + dur_delta | |||
table.insert(tier_notes, "T" .. i .. " upgrade " | |||
.. (dur_delta > 0 and "increases" or "decreases") | |||
.. " duration by " .. math.abs(dur_delta) | |||
.. "s (total " .. total_dur .. "s).") | |||
running_dur = total_dur | |||
end | |||
end | |||
end | |||
for _, n in ipairs(tier_notes) do | |||
table.insert(notes, n) | |||
end | |||
end | |||
end | |||
end | |||
if #notes > 0 then | |||
cells["Notes"] = table.concat(notes, " ") | |||
end | |||
return cells | |||
end | end | ||
local extra_columns = { | |||
["charges"] = { | |||
headers = { "Charges", "Time Between Charges", "Notes" }, | |||
get_cells = charges_cells, | |||
}, | |||
["melee"] = { | |||
headers = { "Light Melee Scaling", "Notes" }, | |||
get_cells = melee_cells, | |||
}, | |||
["healreduce"] = { | |||
headers = { "Heal Reduction", "Duration", "Notes" }, | |||
get_cells = healreduce_cells, | |||
}, | |||
} | |||
-- ============================================================ | |||
-- Hero lookup (ability key -> { heroName, abilityNum }) | |||
-- ============================================================ | |||
if | local _hero_lookup = nil | ||
local function build_hero_lookup() | |||
if _hero_lookup then return _hero_lookup end | |||
_hero_lookup = {} | |||
local hero_data = mw.loadJsonData("Data:HeroData.json") | |||
local active_heroes = {} | |||
for _, hero in pairs(hero_data) do | |||
if type(hero) == "table" | |||
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 | end | ||
local | local cards = mw.loadJsonData("Data:AbilityCards.json") | ||
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) | |||
if slot_num and type(ability) == "table" and ability["Key"] then | |||
_hero_lookup[ability["Key"]] = { | |||
heroName = hero_name, | |||
abilityNum = slot_num, | |||
} | |||
end | |||
end | |||
end | |||
end | |||
end | |||
return _hero_lookup | |||
end | end | ||
| Line 215: | Line 362: | ||
local stat = mw.text.trim(frame.args[1] or ""):lower() | local stat = mw.text.trim(frame.args[1] or ""):lower() | ||
local internal_keys = | local internal_keys = stat_to_props[stat] | ||
if not internal_keys then | if not internal_keys then | ||
return '<span class="error">AbilityTable: unknown | return '<span class="error">AbilityTable: unknown stat "' .. stat .. '".</span>' | ||
end | end | ||
-- Build set of columns to hide from the "hide" parameter | |||
local hide_set = {} | local hide_set = {} | ||
local hide_param = mw.text.trim(frame.args["hide"] or "") | local hide_param = mw.text.trim(frame.args["hide"] or "") | ||
if hide_param ~= "" then | if hide_param ~= "" then | ||
for col in hide_param:gmatch("[^,]+") do hide_set[mw.text.trim(col)] = true end | for col in hide_param:gmatch("[^,]+") do | ||
hide_set[mw.text.trim(col)] = true | |||
end | |||
end | end | ||
local | local lookup = build_hero_lookup() | ||
local spec = extra_columns[stat] | local spec = extra_columns[stat] | ||
local headers = spec and spec.headers or {} | local headers = spec and spec.headers or {} | ||
local get_cells = spec and spec.get_cells or function() return {} end | local get_cells = spec and spec.get_cells or function() return {} end | ||
local stat_notes = | local stat_notes = human_notes[stat] | ||
local abilities = GameData.get_entities(GameData.Dataset.ABILITIES, internal_keys) | |||
-- Keep only abilities belonging to active, released heroes | |||
local filtered = {} | local filtered = {} | ||
for _, | for _, ability in ipairs(abilities) do | ||
if | local key = ability["Key"] | ||
table.insert(filtered, | if key and lookup[key] then | ||
table.insert(filtered, ability) | |||
end | end | ||
end | end | ||
if #filtered == 0 then | if #filtered == 0 then | ||
return "No abilities found for | return "No abilities found for stat: " .. stat | ||
end | end | ||
-- Sort by hero name, then ability slot number | |||
table.sort(filtered, function(a, b) | |||
local ia = lookup[a["Key"]] | |||
local ib = lookup[b["Key"]] | |||
if ia.heroName ~= ib.heroName then | |||
return ia.heroName < ib.heroName | |||
. | |||
end | end | ||
return ia.abilityNum < ib.abilityNum | |||
end) | |||
-- Determine final header list, respecting hide_set. | |||
-- "Notes" is included if declared in headers or if human notes exist, | |||
-- but only if not hidden. Either way it appears exactly once at the end. | |||
local has_notes_header = false | local has_notes_header = false | ||
local final_headers = {} | local final_headers = {} | ||
| Line 305: | Line 420: | ||
end | end | ||
local needs_notes = (has_notes_header or stat_notes ~= nil) and not hide_set["Notes"] | 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 | if needs_notes then | ||
table.insert(final_headers, "Notes") | |||
end | |||
-- Disclaimer | |||
local edit_url = mw.uri.fullUrl("Module:AbilityTable", { action = "edit" }) | |||
local disclaimer = frame:preprocess( | |||
'<div class="ability-table-disclaimer">' | |||
.. "This is an automatic list. " | |||
.. "[" .. tostring(edit_url) .. " Click here]" | |||
.. " to add notes or correct the contents." | |||
.. "</div>" | |||
) | |||
-- Render wikitable | |||
local out = {} | local out = {} | ||
table.insert(out, disclaimer) | table.insert(out, disclaimer) | ||
table.insert(out, '{| class=" | table.insert(out, '{| class="wikitable sortable ability-table"') | ||
local | local header_cells = '! class="ability-table-col-hero" | Hero' | ||
.. ' !! class="ability-table-col-ability" | Ability' | |||
for _, h in ipairs(final_headers) do | for _, h in ipairs(final_headers) do | ||
local cls = "ability-table-col-" .. h:lower():gsub("%s+", "-") | |||
header_cells = header_cells .. ' !! class="' .. cls .. '" | ' .. h | |||
end | end | ||
table.insert(out, | table.insert(out, header_cells) | ||
for _, ability in ipairs(filtered) do | |||
for _, | local info = lookup[ability["Key"]] | ||
local | |||
local hero_cell = frame:expandTemplate{ | |||
title = "HeroIcon", | |||
args = { info.heroName } | |||
} | |||
local ability_cell = frame:expandTemplate{ | local ability_cell = frame:expandTemplate{ | ||
title = "AbilityIcon", | title = "AbilityIcon", | ||
args = { ability["Name"] } | args = { ability["Name"] } | ||
} | } | ||
local extra = get_cells(ability) | local extra = get_cells(ability) | ||
-- Append human note to any renderer-generated note | |||
if stat_notes and stat_notes[ability["Name"]] then | |||
local human = stat_notes[ability["Name"]] | |||
extra["Notes"] = extra["Notes"] and (extra["Notes"] .. " " .. human) or human | |||
end | end | ||
local row_cells = '| class="ability-table-cell-hero" | ' .. hero_cell | |||
.. ' || class="ability-table-cell-ability" | ' .. ability_cell | |||
for _, header in ipairs(final_headers) do | for _, header in ipairs(final_headers) do | ||
local value = extra[header] | local value = extra[header] | ||
local cls = "ability-table-cell-" .. header:lower():gsub("%s+", "-") | local cls = "ability-table-cell-" .. header:lower():gsub("%s+", "-") | ||
local content | local content | ||
if value ~= nil then | |||
local suffix = column_suffix[header] or "" | |||
content = value .. suffix | |||
else | |||
content = "—" | |||
end | |||
row_cells = row_cells .. ' || class="' .. cls .. '" | ' .. content | |||
end | end | ||
table.insert(out, "|-") | table.insert(out, "|-") | ||
table.insert(out, | table.insert(out, row_cells) | ||
end | end | ||