Editing Module:HeroData

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:
local p = {};
local p = {};
local heroes_data = mw.loadJsonData("Data:HeroData.json")
local heroes_data = mw.loadJsonData("Data:HeroData.json")
local attributes_data = mw.loadJsonData("Data:AttributeData.json")
local attribute_orders = mw.loadJsonData("Data:StatInfoboxOrder.json")
local util_module = require('Module:Utilities')
local util_module = require('Module:Utilities')
local lang_module = require('Module:Lang')
local lang_module = require('Module:Lang')
 
local dictionary_module = require('Module:Dictionary')
--------------------------------------------------------------------------------
local attribute_module = require('Module:AttributeData')
-- Internal helpers
--------------------------------------------------------------------------------
 
-- 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
local TAG_NAME_MAP = {
["Abrams"] = "Abrams",
["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",
}
 
--------------------------------------------------------------------------------
-- Data access, for use by other modules
--------------------------------------------------------------------------------


-- returns the table of a specific item, used by external modules
-- returns the table of a specific item, used by external modules
Line 83: Line 18:
end
end


-- Hero table for a hero_* key or an exact English name, or nil.
-- Returns an array of item tables that have the same properties
local function hero_by_key_or_name(input)
-- @function   get_similar_items
local hero = heroes_data[input]
-- @param      {string}
if (hero == nil) then hero = p.get_json_item(input) end
-- @return    {array of tables}
return hero
local function get_similar_items(property)
end
local similarItems = {}
 
for _, v in pairs(heroes_data) do
-- Value of a stat, checking the hero's top level, then Weapon, then AltFire.
if (v[property] ~= nil) then
-- Returns nil when the hero has no such stat.
table.insert(similarItems, 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
 
-- Ordered list of a hero's scalings for a stat, Level first then Spirit:
--   { { type = "Level", value = 1.5 }, { type = "Spirit", value = 0.04 } }
-- Absent scalings are omitted, so an empty list means "no scaling". Zero
-- scalings are omitted too unless include_zero is set, which only the
-- deprecated get_hero_scaling_data below needs.
function p.get_scalings(hero_data, stat, include_zero)
local scalings = {}
for _, scaling_type in ipairs({"Level", "Spirit"}) do
local value = raw_scaling(hero_data, scaling_type, stat)
if (value ~= nil and (include_zero or value ~= 0)) then
table.insert(scalings, { type = scaling_type, value = value })
end
end
end
end
return scalings
return similarItems
end
end


-- DEPRECATED, kept for [[Module:HeroComparisonTable]]. Use p.get_scalings.
-- returns the key of the specified hero's english name
-- Keyed by scaling value, so it silently drops an entry when Level and Spirit
function p.get_hero_key(name)
-- scale by the same amount, and it keeps zero scalings.
for i,v in pairs(heroes_data) do
function p.get_hero_scaling_data(hero_data, hero_stat_key)
if (v["Name"] == name) then
local scaling_data_returned = {}
return i
-- Walked backwards so Level is written last and wins a value collision,
-- matching the original Spirit-then-Level assignment order.
local scalings = p.get_scalings(hero_data, hero_stat_key, true)
for i = #scalings, 1, -1 do
scaling_data_returned[scalings[i].value] = scalings[i].type
end
return scaling_data_returned
end
 
-- Whether a hero has a stat at all: a non-zero base value, or any scaling.
function p.has_stat(hero_data, stat)
local base = p.get_stat(hero_data, stat)
if (base ~= nil and base ~= 0) then return true end
return #p.get_scalings(hero_data, stat) > 0
end
 
-- Resolves a hero_* key or an English hero name to a hero_* key.
-- Returns nil when the input matches no hero. Name matching is case-insensitive.
function p.find_hero_key(input)
if (input == nil or input == '') then return nil end
if (heroes_data[input] ~= nil) then return input end
local wanted = mw.ustring.lower(input)
for hero_key, hero_data in pairs(heroes_data) do
if (hero_data["Name"] and mw.ustring.lower(hero_data["Name"]) == wanted) then
return hero_key
end
end
end
end
Line 155: Line 42:
end
end


-- A hero's Nth roster tag (1-3) by English name, or '' when there is no such tag.
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
--------------------------------------------------------------------------------
-- Wikitext entry points
--------------------------------------------------------------------------------
-- returns the key of the specified hero's english name
function p.get_hero_key(frame)
local hero_name_input = frame.args[1]
if not hero_name_input then
return "Error: Hero name not specified."
end
return p.find_hero_key(hero_name_input) or "Hero not found."
end
--{{#invoke:HeroData|resolve_key|HERO_KEY_OR_NAME}}--
-- The matching hero_* key, or '' when the input matches no hero.
function p.resolve_key(frame)
return p.find_hero_key(frame.args[1]) or ''
end


--{{#invoke:HeroData|get_hero_var|HERO_NAME|STAT_NAME|sig_figs_or_localize}}--
--{{#invoke:HeroData|get_hero_var|HERO_NAME|STAT_NAME|sig_figs_or_localize}}--
Line 189: Line 50:
     local sig_figs_or_localize = frame.args[3]
     local sig_figs_or_localize = frame.args[3]
      
      
     local hero = hero_by_key_or_name(hero_name)
     local hero = heroes_data[hero_name]
    if(hero == nil) then hero = p.get_json_item(hero_name) end
     if(hero == nil) then return "Hero Not Found" end
     if(hero == nil) then return "Hero Not Found" end
      
      
     local var_value = p.get_stat(hero, hero_stat_key)
    -- Check top-level first, then Weapon, then AltFire
     local var_value = hero[hero_stat_key]
    if var_value == nil and hero.Weapon then
        var_value = hero.Weapon[hero_stat_key]
    end
    if var_value == nil and hero.Weapon and hero.Weapon.AltFire then
        var_value = hero.Weapon.AltFire[hero_stat_key]
    end
   
     if(var_value == nil) then return 0 end
     if(var_value == nil) then return 0 end
      
      
Line 215: Line 85:
     local sig_figs_or_localize = frame.args[3]
     local sig_figs_or_localize = frame.args[3]
      
      
     local hero = hero_by_key_or_name(hero_name)
     local hero = heroes_data[hero_name]
    if(hero == nil) then hero = p.get_json_item(hero_name) end
     if(hero == nil) then return "Hero Not Found" end
     if(hero == nil) then return "Hero Not Found" end
      
      
Line 242: Line 113:
local hero_name = frame.args[1]
local hero_name = frame.args[1]
local var = frame.args[2]
local var = frame.args[2]
local number_int = tonumber(frame.args[3])
local number_str = frame.args[3]
local localize_arg = frame.args[4]
local number_int = tonumber(number_str)
local localize = frame.args[4]
local hero = hero_by_key_or_name(hero_name)
local hero = heroes_data[hero_name]
if(hero == nil) then hero = p.get_json_item(hero_name) end
if(hero == nil) then return "Hero Not Found" end
if(hero == nil) then return "Hero Not Found" end
local list = p.get_stat(hero, var)
-- Check top-level first, then Weapon, then AltFire
local list = hero[var]
if list == nil and hero.Weapon then
    list = hero.Weapon[var]
end
if list == nil and hero.Weapon and hero.Weapon.AltFire then
    list = hero.Weapon.AltFire[var]
end
if (list == nil) then return "" end
if (list == nil) then return "" end
local element = list[number_int]
local element = list[number_int]
if (element == nil) then return "" end
if (element == nil) then return "" end
if localize_arg=="true" then  
if localize=="true" then  
element = lang_module.get_string(element)
element = lang_module.get_string(element)
end
end
Line 293: Line 174:
if (hero == nil) then return "Hero not found, must be unlocalized" end
if (hero == nil) then return "Hero not found, must be unlocalized" end
local template_title = 'PageRef'
local template_title = 'PageRef'
for i, item_key in ipairs(hero["RecommendedItems"] or {}) do
for i, item_key in ipairs(hero["RecommendedItems"]) do
local template_args = {}
template_args = {}
template_args[1] = lang_module.get_string(item_key, 'en')
template_args[1] = lang_module.get_string(item_key, 'en')
template_args['alt_name'] = localize(item_key, item_key)
template_args['alt_name'] = localize(item_key, item_key)
Line 302: Line 183:
return str
return str
end
end


--If the hero scales with the stat, it returns {{Ss|value}} or {{PI|value}}, else blank string
--If the hero scales with the stat, it returns {{Ss|value}} or {{Ls|value}}, else blank string
--{{#invoke:HeroData|get_hero_scalar|HERO_NAME|SCALING_TYPE|STAT_NAME|sig_figs_or_localize}}--
--{{#invoke:HeroData|get_hero_scalar|HERO_NAME|SCALING_TYPE|STAT_NAME|sig_figs_or_localize}}--
p.get_hero_scalar = function(frame)
p.get_hero_scalar = function(frame)
Line 310: Line 192:
local hero_stat_key = frame.args[3]
local hero_stat_key = frame.args[3]
local sig_figs_or_localize = frame.args[4]
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)
local hero_data = heroes_data[hero_key]
if(hero_data == nil) then hero_data = p.get_json_item(hero_key) end
if(hero_data == nil) then return "Hero not found." end
if(hero_data == nil) then return "Hero not found." end
local scaling_value = raw_scaling(hero_data, scaling_type, hero_stat_key)
local scaling_data = hero_data[scaling_type .. "Scaling"]
if scaling_value == nil then return "" end
if scaling_data == nil then return scaling_type .. "Scaling data not found for hero" .. hero_key end
local scaling_value = scaling_data[hero_stat_key]
if scaling_value == nil then return scaling_type .. "Scaling data does not have key " .. hero_stat_key .. " for hero " .. hero_key end


--round
--round
Line 329: Line 214:
end
end
if no_template == "true" then
local scaling_str = p.write_scalar_str(scaling_value, scaling_type)
return scaling_value
 
end
return scaling_str
end
 
-- Retrieve scaling string of a hero's given stat, if it has scaling, else return blank
-- Scaling string meaning the expanded template {{Ss|scalar}} or {{Ls|scalar}}
function p.write_scalar_str(scaling_value, scaling_type)
local scaling_abbrevs = {Spirit = "Ss", Level = "PI"}
-- 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] --scaling type's abbreviation
local template_args = {}
template_args["1"] = scaling_value --store in 1st arg for {{{1}}} to grab it from {{SS}} or {{LS}} template
return p.write_scalar_str(scaling_value, scaling_type)
local template_call = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
return template_call
end
end


-- Check if a hero has a stat (Base, Boons, or Spirit Scaling)
-- Retrieve scaling value and type of a hero's given stat, if it has scaling, else return 0
-- Returns "true" if found, nil if not (for #if templates)
function p.get_hero_scaling_data(hero_data, hero_stat_key)
p.hero_has_stat = function(frame)
local scaling_type_full
local hero_key = frame.args[1]
local scaling_data
local stat_key = frame.args[2]
local scaling_value
if (hero_key == nil) then return nil end
local scaling_types = {"Spirit", "Level"}
local scaling_data_returned = {}
local hero_data = hero_by_key_or_name(hero_key)
for index, scaling_type in ipairs(scaling_types) do
if (hero_data == nil) then return nil end
scaling_type_full = scaling_type .. "Scaling"
scaling_data = hero_data[scaling_type_full]
--If the scaling data exists
if (scaling_data ~= nil) then
scaling_value = scaling_data[hero_stat_key]
--If the stat scales
if (scaling_value ~= nil) then
scaling_data_returned[scaling_value] = scaling_type
end
end
end
if p.has_stat(hero_data, stat_key) then return "true" end
return scaling_data_returned
return nil
end
end


-- Function to call hero tags based on name
--HERO_NAME in english
p.get_hero_tag = function (frame)
--{{#invoke:HeroData|write_infobox|HERO_NAME}}--
local name = frame.args[1]
p.write_infobox = function(frame)
local number = tonumber(frame.args[2])
-- Get hero data
 
    hero_key = frame.args[1]
-- Validate input
    hero_data = heroes_data[hero_key]
if not name then
    if(hero_data == nil) then return "Hero " .. hero_key .. " Not Found" end
return "Error: Missing name input."
   
    local infobox_attributes = {
        Weapon = {'DPS','ClipSize','RoundsPerSecond','ReloadTime'},
        Vitality = {'MaxHealth','BulletResist','TechResist','MaxMoveSpeed'}
    }
   
    -- Declarations and initializations
    local category_data = attribute_module.get_category_data()
    local stats
    local stat_data
    local stat_value
    local stat_text
    local label
    local postfix
    local should_display
    local image_file_name
    local image_file
    local icon_and_value_str
    local template_args = {}
    local stat_values = {Weapon = "", Vitality = ""}
   
    -- Add the main parameters
    template_args["name_english"] = lang_module.get_string(hero_key, 'en')
    template_args["name_localized"] = localize(hero_key, hero_key)
   
    -- Iterate attribute categories
    for category, stats in pairs(infobox_attributes) do
-- Iterate stats
for _, stat_name in ipairs(stats) do
-- Confirm its in attribute data and retrieve it
attribute_data = attributes_data[category]
if (attribute_data == nil) then return "Category " .. category .. " in infobox_attributes is not in Data:AttributeData" end
stat_data = attribute_data[stat_name]
if (stat_data == nil) then return "Attribute " .. stat_name .. " in infobox_attributes is not in Data:AttributeData" end
-- gets the stat's value
stat_value = hero_data[stat_name]
if (stat_value == nil) then
    -- Check nested weapon stats
    if hero_data.Weapon and hero_data.Weapon[stat_name] ~= nil then
        stat_value = hero_data.Weapon[stat_name]
    elseif hero_data.Weapon and hero_data.Weapon.AltFire and hero_data.Weapon.AltFire[stat_name] ~= nil then
        stat_value = hero_data.Weapon.AltFire[stat_name]
    else
        stat_value = 0 --default to 0 if not present
    end
end
--Round value to 3 significant figures
stat_value = util_module.round_to_sig_fig(stat_value, 3)
-- get label and postfix
label = localize(stat_data["label"], stat_name)
postfix = stat_data["postfix"]
if (postfix == nil) then
postfix = ""
else
-- light grey for postfixes
postfix = lang_module.get_string(postfix)
if (postfix == nil) then
postfix = ""
end
postfix = '<span style="color: #666666;">' .. postfix .. "</span>"
end
-- if a language is missing the postfix, use no postfix
-- Check if icon file exists, and if not, don't use any image
image_file_name = 'File:AttributeIcon' .. stat_name .. '.png'
image_file = util_module.get_image_file(image_file_name, 15, stat_name)
-- Create the template'd icon
local icon_color = attribute_module.get_attr_icon_color(stat_name)
icon_template_title = mw.title.new("Template:Icon/" .. icon_color)
icon_template_args = {}
icon_template_args[1] = image_file
icon_template_args[2] = stat_value .. postfix
icon_and_value_str = mw.getCurrentFrame():expandTemplate{ title = icon_template_title, args = icon_template_args }
label =  ',<span style="color: #999999; background-color: #2F2F2F; display: inline-flex; width: 100%; height: 100%; justify-content: center; align-items: center;">' .. label .. '</span>'
-- First add localized stat name for left column
stat_values[category] = stat_values[category] .. label
-- Then add icon and stat value for right column
stat_values[category] = stat_values[category] .. ',' .. icon_and_value_str
end
-- Add the stat values in the category to i.e weapon_values and vitality_values parameters
template_args[string.lower(category) .. "_values"] = stat_values[category]
end
end
   
    -- Use expandTemplate to evaluate the Infobox_hero template
    local template_title = mw.title.new("User:Sur")
    local expanded_template = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
   
    return expanded_template
end


if number ~= 1 and number ~= 2 and number ~= 3 then
return string.format("Error: Invalid number '%s'. Must be 1, 2, or 3.", tostring(frame.args[2]))
end


if TAG_NAME_MAP[name] == nil then
--{{#invoke:HeroData|write_stat_infoboxes|HERO_KEY}}
return string.format("Error: Unknown name '%s'.", name)
--Creates {{Infobox_stat}}'s' for the 3 categories Weapon, Vitality, Spirit
p.write_stat_infoboxes = function(frame)
local hero_key = frame.args[1]
if(hero_key == nil) then return "Hero parameter missing" end
-- Use expandTemplate to evaluate the Infobox_hero template
    local template_title = mw.title.new("Template:Infobox_stat") --name of the template
    local template_calls = '<div style="display: flex; flex-direction: column;">' --all template calls concatenated
    local template_call --current template call
local template_args = {} --current template arguments
local cell_values --current cell values
local cell_value --current cell value
local label --current stat's label
local postfix --current stat's postfix
local stat_value --current stat's numerical value in the hero data
local hero_data = heroes_data[hero_key]
local stats --stats of the current category
local image_file_name --name of the image_file to check
local image_file --mw returned image file
local extra_blank_cell --add a blank cell after certain stats
local stats_to_add_blank_after = {CritDamageReceivedPercent = true}
if (hero_data == nil) then return "Hero Not Found" end
local category_data = attribute_module.get_category_data()
local should_display
for _, category in ipairs(attribute_orders["category_order"]) do
if (category ~= "Spirit") then --hide Spirit section for now
stats = attributes_data[category]
local category_values = category_data[category]
template_args["box_name"] = category_values.unlocalized_name
template_args["box_rgb"] = category_values.rgb
template_args["num_cols"] = 2
cell_values = ""
-- Determine cell values
for _, stat_name in ipairs(attribute_orders[category]["attribute_order"]) do
local stat_data = stats[stat_name]
if stat_data == nil then return "Stat " .. stat_name .. " from StatInfoboxOrder has no data in AttributeData" end
-- gets the stat's value if it has that stat, default to 0 if not
stat_value = hero_data[stat_name]
if (stat_value == nil) then
    -- Check nested weapon stats
    if hero_data.Weapon and hero_data.Weapon[stat_name] ~= nil then
        stat_value = hero_data.Weapon[stat_name]
    elseif hero_data.Weapon and hero_data.Weapon.AltFire and hero_data.Weapon.AltFire[stat_name] ~= nil then
        stat_value = hero_data.Weapon.AltFire[stat_name]
    else
        stat_value = 0 --default to 0 if not present
    end
end
--Round value to 3 significant figures
stat_value = util_module.round_to_sig_fig(stat_value, 3)
-- get label and postfix
label = localize(stat_data["label"], stat_name)
postfix = stat_data["postfix"]
if (postfix == nil) then
postfix = ""
else
-- light grey for postfixes
postfix = '<span style="color: #666666;">' .. lang_module.get_string(postfix) .. "</span>"
end
-- if a language is missing the postfix, use no postfix
if (postfix == nil) then
postfix = ""
end
-- Check if icon file exists, and if not, don't use any image
image_file_name = 'File:AttributeIcon' .. stat_name .. '.png'
-- 15px and link to stat name (page name might not match perfectly yet)
image_file = util_module.get_image_file(image_file_name, 15, stat_name)
-- Create the template'd icon
local icon_color = attribute_module.get_attr_icon_color(stat_name)
if (icon_color == "Brown") then
image_file = '<span style="position: relative; bottom: 2px; filter: invert(42%) sepia(10%) saturate(2912%) hue-rotate(351deg) brightness(90%) contrast(87%);">' .. image_file .. '</span>'
end
-- use white instead of grey if grey is returned
-- Add an empty cell following some stats to align them correctly as seen in game
if (stats_to_add_blank_after[stat_name]) then
extra_blank_cell = " ," --prefixed space is needed
else
extra_blank_cell = ""
end
-- slightly lighter color for stat name
label = '<span style="color: #3d3d3d;">' .. label .. '</span>'
-- Add the scaling str if it scales
local scaling_data = p.get_hero_scaling_data(hero_data, stat_name)
local scaling_strs = ""
if (scaling_data ~= nil) then
for scaling_value, scaling_type in pairs(scaling_data) do
local scaling_str = p.write_scalar_str(scaling_value, scaling_type)
if (scaling_str ~= "") then scaling_str = " " .. scaling_str end
scaling_strs = scaling_strs .. scaling_str
end
end
-- Set cell value as "Icon StatvaluePostfix Statname Scaling,"
-- If icon file already exists, set it to #REDIRECT to the duplicate file page
cell_value = image_file .. " " .. stat_value  .. postfix .. " " .. label  .. scaling_strs .. "," .. extra_blank_cell
cell_values = cell_values .. cell_value --add value to values list
end
template_args["cell_values"] = cell_values
-- Write current call
template_call = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
-- Add call to the set of calls
template_calls = template_calls .. "\n" .. template_call
end
end
end
 
return p.hero_tag(name, number)
return template_calls .. "</div>"
end
end


--{{#invoke:HeroData|has_tags|HERO_ENGLISH_NAME}}--
local function get_nested_stat_value(hero_data, stat_key)
-- 'true' when the hero has roster tags, '' otherwise.
    -- Check top-level, then Weapon, then AltFire
function p.has_tags(frame)
    if hero_data[stat_key] ~= nil then
if p.hero_tag(frame.args[1], 1) ~= '' then return 'true' end
        return hero_data[stat_key]
return ''
    elseif hero_data.Weapon and hero_data.Weapon[stat_key] ~= nil then
        return hero_data.Weapon[stat_key]
    elseif hero_data.Weapon and hero_data.Weapon.AltFire and hero_data.Weapon.AltFire[stat_key] ~= nil then
        return hero_data.Weapon.AltFire[stat_key]
    end
    return 0
end
end


-- Retrieve scaling string of a hero's given stat, if it has scaling, else return blank
--writes the massive hero comparison table for a specific PI and SP
-- Scaling string meaning the expanded template {{Ss|scalar}} or {{PI|scalar}}
-- scaling icons are shown only if PI and SP are both 0 or both not provided
function p.write_scalar_str(scaling_value, scaling_type, compact)
--{{#invoke:HeroData|write_hero_comparison_table|POWER_INCREASES|SPIRIT_POWER}}
local scaling_abbrevs = {Spirit = "Ss", Level = "PI"}
p.write_hero_comparison_table = function(frame)
-- process inputs
local power_increases = frame.args[1]
if (power_increases == nil) then power_increases = 0 end
local spirit_power = frame.args[2]
if (spirit_power == nil) then spirit_power = 0 end
-- Show scaling icons if power/increases/spirit power are 0/not specified
local display_scaling_icons = false
if (power_increases == 0 and spirit_power == 0) then
display_scaling_icons = true
end
-- Return blank if it doesnt scale
-- Initializations and declarations
if (scaling_value == 0) then return "" end
local row_str = ""
local body_str = ""
local in_development
local is_disabled
local template_title = ""
local template_args = {}
local hero_icon
local hero_td_style
local scalar_str
-- Round it
-- Add hero comp stats to
scaling_value = util_module.round_to_sig_fig(scaling_value, 3)
local stats_to_include = {
Weapon = {
"DPS",
            "SustainedDPS",
            "BulletDamage",
            "RoundsPerSecond",
            "FireRate",
            "ClipSize",
            "ReloadTime",
            "ReloadDelay",
            "BulletsPerShot",
            "BulletsPerBurst",
            "BurstInterShotInterval",
            "LightMeleeDamage",
            "HeavyMeleeDamage",
            "ReloadSingle",
            "BulletSpeed",
            "BulletGravityScale",
            "FalloffStartRange",
            "FalloffEndRange",
            "BonusAttackRange",
            "CritDamageBonusPercent",
            "RoundsPerSecondAtMaxSpin",
            "SpinAcceleration",
            "SpinDeceleration"
},
Vitality = {
"MaxHealth",
            "BaseHealthRegen",
            "BulletResist",
            "TechResist",
            "CritDamageReceivedPercent",
            "MaxMoveSpeed",
            "SprintSpeed",
            "StaminaCooldown",
            "Stamina"
},
    Spirit = {
"TechPower"
}
}
--The hero has a scaling value with this stat
-- Iterate heroes
local template_title = "Template:" .. scaling_abbrevs[scaling_type]
for hero_key, hero_data in pairs(heroes_data) do
local template_args = {}
-- Ensure they are not in development and they are an active hero
template_args["1"] = scaling_value
in_development = hero_data["InDevelopment"]
if compact then  
if (not in_development) then
template_args["compact"] = "yes"
is_disabled = hero_data["IsDisabled"]
template_args["show_value"] = "yes"
if (not is_disabled) then
--Add the row's stats
row_str = ""
-- Retrieve hero's localized name
hero_name = localize(hero_key, hero_key)
-- Retrieve hero's english name, used for hero icon
hero_name_en = hero_data["Name"]
-- Expand hero icon
template_title = "Template:HeroIcon"
template_args[1] = hero_name_en
template_args[2] = hero_name
hero_icon = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
-- First column in each row is hero name
row_str = row_str .. "<td>" .. hero_icon .. "</td>"
-- Consecutive columns are then stats
-- Iterate categories
for _, category in ipairs(attribute_orders["category_order"]) do
category_attrs = attributes_data[category]
-- Iterate attributes within the category
if (stats_to_include[category] ~= nil) then
for _, attr_key in ipairs(stats_to_include[category]) do
--Retrieve the stats value from hero data
stat_value = get_nested_stat_value(hero_data, attr_key)
-- Retrieve scaling val and str if it scales
local scaling_data = p.get_hero_scaling_data(hero_data, attr_key)
local scaling_strs = ""
if (scaling_data ~= nil) then
for scaling_value, scaling_type in pairs(scaling_data) do
local scaling_str = p.write_scalar_str(scaling_value, scaling_type)
if (scaling_str ~= "") then scaling_str = " " .. scaling_str end
if (scaling_str ~= nil) then
scaling_strs = scaling_strs .. scaling_str
end
-- Scale the stat value
if (scaling_type == "Spirit") then
stat_value = stat_value + (spirit_power * scaling_value)
elseif (scaling_type == "Level") then
if attr_key == 'TechResist' or attr_key == 'BulletResist' then
-- each PI for resists is multiplicative
stat_value = (stat_value/100 + 1 - (1-scaling_value/100)^power_increases)*100
else
stat_value = stat_value + (power_increases * scaling_value)
end
end
end
end
if (not display_scaling_icons) then scaling_strs = "" end
-- Convert from boolean to string, or round it
if (type(stat_value)) == 'boolean' then
stat_value = tostring(stat_value)
else
stat_value = util_module.round_to_sig_fig(stat_value, 3)
end
-- Add it to the row
row_str = row_str .. "<td>" .. stat_value .. scaling_strs .. "</td>"
end
end
end
-- Add row to the body
row_str = "<tr>" .. row_str .. "</tr>"
body_str = body_str .. row_str
first_hero = false
end
end
end
end
local template_call = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args }
local result = template_call:gsub("\n", ""):gsub("\r", "")
-- First header is Hero
   
local headers_str = "<th>" .. "Hero" .. "</th>"
local header_style = ""
local category_data = attribute_module.get_category_data()
local postfix
-- Used for keys that are not localized by Valve
local postfix_key_map = {
["ReloadDelay"] = "StatDesc_ReloadTime_postfix",
["BulletsPerShot"] = "",
["BulletsPerBurst"] = "",
["BurstInterShotInterval"] = "StatDesc_ReloadTime_postfix",
["ReloadSingle"] = "",
["BonusAttackRange"] = "StatDesc_WeaponRangeFalloffMax_postfix",
["SustainedDPS"] = "DPS_postfix",
["RoundsPerSecondAtMaxSpin"] = "",
["CritDamageBonusScale"] = "StatDesc_CritDamageBonusScale_postfix",
["BonusCritDamagePercent"] = "BonusCritDamagePercent_postfix",
}
-- Iterate stats again for displaying headers with their respective color
for _, category in ipairs(attribute_orders["category_order"]) do
category_attrs = attributes_data[category]
category_rgb = category_data[category]["rgb"]
-- Iterate attributes within the category
if (stats_to_include[category] ~= nil) then
for _, attr_key in ipairs(stats_to_include[category]) do
attr_data = category_attrs[attr_key]
if (attr_data ~= nil) then
-- Localize, fallback to attr_key with proper spaces
attr_localized = lang_module.get_string(attr_data["label"])
if (attr_localized == nil or attr_localized == "") then attr_localized = util_module.add_space_before_cap(attr_key) end
-- Get postfix
postfix = lang_module.get_string(attr_data["postfix"])
if (postfix == nil or postfix == "") then
postfix = ""
else
postfix = " (" .. postfix .. ")"
end
else -- If not in attributes data, use dictionary translate and postfix
attr_localized = dictionary_module.translate(attr_key)
postfix = lang_module.get_string(postfix_key_map[attr_key])
if postfix == nil then
return "attr_key " .. attr_key .. " must be added to postfix_key_map"
end
if postfix ~= "" then
postfix = " (" .. postfix .. ")"
end
end
header_style = ' style="background-color: ' .. "rgb(" .. category_rgb .. ') ;"'
headers_str = headers_str .. "<th" .. header_style .. ">" .. attr_localized .. postfix .. "</th>"
end
end
end
headers_str = "<tr>" .. headers_str .. "</tr>"
 
local table_str = '<table class="wikitable sortable" style="table-layout: auto; width: 100%;">' .. headers_str .. body_str .. "</table>"
local output_str = '<div style="overflow-x: auto; width: 100%;">' .. table_str .. '</div>'
return output_str
end
 
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
return result
end
-- Mapping from hero name to internal tag name
local TAG_NAME_MAP = {
["Abrams"] = "Abrams",
["Bebop"] = "Bebop",
["Billy"] = "Punkgoat",
["Calico"] = "Nano",
["The Doorman"] = "Doorman",
["Drifter"] = "Drifter",
["Dynamo"] = "Dynamo",
["Fencer"] = "Fencer",
["Graves"] = "Necromancer",
["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",
    ["Pepper"] = "unicorn",
    ["Pocket"] = "Synth",
    ["Rem"] = "Familiar",
    ["Seven"] = "Gigawatt",
    ["Shiv"] = "Shiv",
    ["Silver"] = "Werewolf",
    ["Sinclair"] = "Magician",
    ["Venator"] = "Priest",
    ["Victor"] = "Frank",
    ["Vindicta"] = "Vindicta",
    ["Viscous"] = "Viscous",
    ["Vyper"] = "Viper",
    ["Warden"] = "Warden",
    ["Wraith"] = "Wraith",
    ["Yamato"] = "Yamato",
}
-- Function to call hero tags based on name
p.get_hero_tag = function (frame)
    local name = frame.args[1]
    local number = tonumber(frame.args[2])
    -- Validate input
    if not name then
        return "Error: Missing name input."
    end
    if number ~= 1 and number ~= 2 and number ~= 3 then
        return string.format("Error: Invalid number '%s'. Must be 1, 2, or 3.", tostring(frame.args[2]))
    end
    local tagname = TAG_NAME_MAP[name]
    if not tagname then
        return string.format("Error: Unknown name '%s'.", name)
    end
    -- Build localization key
    local key = string.format("Citadel_%s_HeroTag_%d", tagname, number)
    -- Call Lang.get_string
    local result = lang_module.get_string(key)
    return result or ("[Missing string for key: " .. key .. "]")
end
end


Line 410: Line 816:
         [0.62] = {},
         [0.62] = {},
         [0.68] = {},
         [0.68] = {},
         [0.72] = {},
         [0.70] = {},
     }
     }
    local get_dash = function(hero)
        return hero.GroundDashDuration
            or (hero.Weapon and hero.Weapon.GroundDashDuration)
            or (hero.Weapon and hero.Weapon.AltFire and hero.Weapon.AltFire.GroundDashDuration)
    end


     -- Collect heroes
     -- Collect heroes
     for hero_key, hero_data in pairs(heroes_data) do
     for hero_key, hero_data in pairs(heroes_data) do
         if not hero_data.InDevelopment and not hero_data.IsDisabled then
         if not hero_data.InDevelopment and not hero_data.IsDisabled then
             local dash = p.get_stat(hero_data, "GroundDashDuration")
             local dash = get_dash(hero_data)
             if dash and buckets[dash] then
             if dash and buckets[dash] then
                 table.insert(buckets[dash], hero_data.Name or hero_key)
                 table.insert(buckets[dash], hero_data.Name or hero_key)
Line 434: Line 846:
     end
     end


     local output = {"{| class='wikitable mw-collapsible'",
     local output = {"{| class='wikitable'", "! Bucket 1 !! Bucket 2 !! Bucket 3"}
    "|+Hero Dash Buckets", "! Bucket 1 !! Bucket 2 !! Bucket 3"}
     local current_frame = frame or mw.getCurrentFrame()
     local current_frame = frame or mw.getCurrentFrame()


     for i = 1, max_rows do
     for i = 1, max_rows do
         local row = {}
         local row = {}
         for _, bucket in ipairs({0.62, 0.68, 0.72}) do
         for _, bucket in ipairs({0.62, 0.68, 0.70}) do
             local hero_name = buckets[bucket][i]
             local hero_name = buckets[bucket][i]
             table.insert(row, hero_name and current_frame:expandTemplate{title = "HeroIcon", args = {hero_name}} or "")
             table.insert(row, hero_name and current_frame:expandTemplate{title = "HeroIcon", args = {hero_name}} or "")
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:HeroData"