More actions
m exclude heroes in development or disabled |
Gammaton32 (talk | contribs) edited to include labs heroes |
||
(51 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
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') | local attribute_module = require('Module:AttributeData') | ||
Line 15: | Line 16: | ||
end | end | ||
return nil | return nil | ||
end | |||
-- Returns an array of item tables that have the same properties | |||
-- @function get_similar_items | |||
-- @param {string} | |||
-- @return {array of tables} | |||
local function get_similar_items(property) | |||
local similarItems = {} | |||
for _, v in pairs(heroes_data) do | |||
if (v[property] ~= nil) then | |||
table.insert(similarItems, v) | |||
end | |||
end | |||
return similarItems | |||
end | end | ||
Line 35: | Line 50: | ||
local sig_figs_or_localize = frame.args[3] | local sig_figs_or_localize = frame.args[3] | ||
local hero = p.get_json_item(hero_name) | local hero = heroes_data[hero_name] --check if hero key is passed instead | ||
if(hero == nil) then return "Hero Not Found" end | if(hero == nil) then hero = p.get_json_item(hero_name) end --check if hero name is passed | ||
if(hero == nil) then return "Hero Not Found" end --both invalid, error | |||
local var_value = hero[hero_stat_key] | local var_value = hero[hero_stat_key] | ||
Line 49: | Line 65: | ||
--localize | --localize | ||
if (sig_figs_or_localize == "true") then | if (sig_figs_or_localize == "true") then | ||
return lang_module. | return lang_module.get_string(var_value) | ||
end | end | ||
Line 62: | Line 78: | ||
local number_int = tonumber(number_str) | local number_int = tonumber(number_str) | ||
local localize = frame.args[4] | local localize = frame.args[4] | ||
local hero = p.get_json_item(hero_name) | local hero = heroes_data[hero_name] --check if hero key is passed instead | ||
if(hero == nil) then hero = p.get_json_item(hero_name) end --check if hero name is passed | |||
if(hero == nil) then return "Hero Not Found" end --both invalid, error | |||
if (hero == nil) then return "Hero " .. hero_name .. " not found" end | if (hero == nil) then return "Hero " .. hero_name .. " not found" end | ||
local list = hero[var] | local list = hero[var] | ||
if (list == nil) then return " | 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=="true" then | if localize=="true" then | ||
element = lang_module. | element = lang_module.get_string(element) | ||
end | end | ||
Line 76: | Line 94: | ||
end | end | ||
p.get_ability_key = function(frame) | |||
local hero_key = frame.args[1] | |||
local bound_slot_number = frame.args[2] | |||
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 | |||
p.write_role_playstyle_quote = function(frame) | |||
local hero_key = frame.args[1] | |||
local hero_data = heroes_data[hero_key] | |||
if (hero_data == nil) then return hero_key.." not found" end | |||
local role_key = hero_data["Role"] | |||
local role_localized = lang_module.get_string(role_key, nil, 'en') | |||
local playstyle_key = hero_data["Playstyle"] | |||
local playstyle_localized = lang_module.get_string(playstyle_key, nil, 'en') | |||
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 | |||
p.write_default_items = function(frame) | |||
local hero_key = frame.args[1] --unlocalized | |||
if (hero_key == nil) then return "No hero key provided" end | |||
local str = "" | |||
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"]) do | |||
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 | |||
--If the hero scales with the stat, it returns {{Ss|value}} or {{Ls|value}}, else blank string | --If the hero scales with the stat, it returns {{Ss|value}} or {{Ls|value}}, else blank string | ||
Line 87: | Line 148: | ||
end | end | ||
function p.get_hero_scalar_str(hero, hero_stat_key) | -- 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.get_hero_scalar_str(scaling_value, scaling_type) | |||
local scaling_abbrevs = {Spirit = "Ss", Level = "Ls"} | |||
-- 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 | |||
local template_call = mw.getCurrentFrame():expandTemplate{ title = template_title, args = template_args } | |||
return template_call | |||
end | |||
-- Retrieve scaling value and type of a hero's given stat, if it has scaling, else return 0 | |||
function p.get_hero_scalar(hero_data, hero_stat_key) | |||
local scaling_type_full | local scaling_type_full | ||
local scaling_data | local scaling_data | ||
local scaling_value | local scaling_value | ||
local scaling_types = {"Spirit", "Level"} | local scaling_types = {"Spirit", "Level"} | ||
local | local scaling_data_returned = {} | ||
for index, scaling_type in ipairs(scaling_types) do | for index, scaling_type in ipairs(scaling_types) do | ||
scaling_type_full = scaling_type .. "Scaling" | scaling_type_full = scaling_type .. "Scaling" | ||
scaling_data = | scaling_data = hero_data[scaling_type_full] | ||
--If the scaling data exists | --If the scaling data exists | ||
Line 104: | Line 187: | ||
--If the stat scales | --If the stat scales | ||
if (scaling_value ~= nil) then | if (scaling_value ~= nil) then | ||
scaling_value | scaling_data_returned[scaling_value] = scaling_type | ||
end | end | ||
end | end | ||
end | end | ||
return scaling_data_returned | |||
end | end | ||
Line 126: | Line 199: | ||
p.write_infobox = function(frame) | p.write_infobox = function(frame) | ||
-- Get hero data | -- Get hero data | ||
hero_key = frame.args[1] | |||
hero_data = | hero_data = heroes_data[hero_key] | ||
if(hero_data == nil) then return "Hero Not Found" end | if(hero_data == nil) then return "Hero " .. hero_key .. " Not Found" end | ||
local infobox_attributes = { | local infobox_attributes = { | ||
Weapon = {'DPS','ClipSize','RoundsPerSecond','ReloadTime'}, | Weapon = {'DPS','ClipSize','RoundsPerSecond','ReloadTime'}, | ||
Vitality = {'MaxHealth',' | Vitality = {'MaxHealth','BulletResist','TechResist','MaxMoveSpeed'} | ||
} | } | ||
Line 151: | Line 224: | ||
-- Add the main parameters | -- Add the main parameters | ||
template_args["name_english | template_args["name_english"] = lang_module.get_string(hero_key, 'en') | ||
template_args["name_localized"] = localize(hero_key, hero_key) | |||
-- Iterate attribute categories | -- Iterate attribute categories | ||
Line 187: | Line 247: | ||
-- get label and postfix | -- get label and postfix | ||
label = | label = localize(stat_data["label"], stat_name) | ||
postfix = stat_data["postfix"] | postfix = stat_data["postfix"] | ||
if (postfix == nil) then | if (postfix == nil) then | ||
Line 193: | Line 253: | ||
else | else | ||
-- light grey for postfixes | -- light grey for postfixes | ||
postfix = lang_module. | postfix = lang_module.get_string(postfix) | ||
if (postfix == nil) then | if (postfix == nil) then | ||
postfix = "" | postfix = "" | ||
Line 235: | Line 295: | ||
--{{#invoke:HeroData|write_stat_infoboxes| | --{{#invoke:HeroData|write_stat_infoboxes|HERO_KEY}} | ||
--Creates {{Infobox_stat}}'s' for the 3 categories Weapon, Vitality, Spirit | --Creates {{Infobox_stat}}'s' for the 3 categories Weapon, Vitality, Spirit | ||
p.write_stat_infoboxes = function(frame) | p.write_stat_infoboxes = function(frame) | ||
local | local hero_key = frame.args[1] | ||
if( | if(hero_key == nil) then return "Hero parameter missing" end | ||
-- Use expandTemplate to evaluate the Infobox_hero template | -- Use expandTemplate to evaluate the Infobox_hero template | ||
Line 251: | Line 311: | ||
local postfix --current stat's postfix | local postfix --current stat's postfix | ||
local stat_value --current stat's numerical value in the hero data | local stat_value --current stat's numerical value in the hero data | ||
local hero_data = | local hero_data = heroes_data[hero_key] | ||
local stats --stats of the current category | local stats --stats of the current category | ||
local image_file_name --name of the image_file to check | local image_file_name --name of the image_file to check | ||
local image_file --mw returned image file | local image_file --mw returned image file | ||
local extra_blank_cell --add a blank cell after certain stats | local extra_blank_cell --add a blank cell after certain stats | ||
local stats_to_add_blank_after = { | local stats_to_add_blank_after = {CritDamageReceivedScale = true} | ||
if (hero_data == nil) then return "Hero Not Found | if (hero_data == nil) then return "Hero Not Found" end | ||
local category_data = attribute_module.get_category_data() | local category_data = attribute_module.get_category_data() | ||
local should_display | local should_display | ||
for _, category in ipairs(attribute_orders["category_order"]) do | for _, category in ipairs(attribute_orders["category_order"]) do | ||
stats = attributes_data[category] | 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 | |||
stat_value = 0 --default to 0 if not present | |||
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_scalar(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.get_hero_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 | 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 | |||
-- Add the | |||
end | end | ||
end | end | ||
Line 343: | Line 412: | ||
--writes the massive hero comparison table for a specific PI and SP | --writes the massive hero comparison table for a specific PI and SP | ||
-- scaling icons are shown only if PI and SP are both 0 or both not provided | |||
--{{#invoke:HeroData|write_hero_comparison_table|POWER_INCREASES|SPIRIT_POWER}} | --{{#invoke:HeroData|write_hero_comparison_table|POWER_INCREASES|SPIRIT_POWER}} | ||
p.write_hero_comparison_table = function(frame) | p.write_hero_comparison_table = function(frame) | ||
Line 351: | Line 421: | ||
if (spirit_power == nil) then spirit_power = 0 end | if (spirit_power == nil) then spirit_power = 0 end | ||
local | -- 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 | |||
-- Initializations and declarations | -- Initializations and declarations | ||
local row_str = "" | local row_str = "" | ||
local body_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 | |||
-- | -- Add hero comp stats to | ||
local | local stats_to_include = { | ||
Weapon = { | |||
"DPS", | |||
"SustainedDPS", | |||
"BulletDamage", | |||
"RoundsPerSecond", | |||
"FireRate", | |||
"ClipSize", | |||
"ReloadTime", | |||
"ReloadDelay", | |||
"BulletsPerShot", | |||
"BulletsPerBurst", | |||
"BurstInterShotInterval", | |||
"LightMeleeDamage", | |||
"HeavyMeleeDamage", | |||
"ReloadSingle", | |||
"BulletSpeed", | |||
"BulletGravityScale", | |||
"FalloffStartRange", | |||
"FalloffEndRange", | |||
"BonusAttackRange", | |||
"RoundsPerSecondAtMaxSpin", | |||
"SpinAcceleration", | |||
"SpinDeceleration" | |||
}, | |||
Vitality = { | |||
"MaxHealth", | |||
"BaseHealthRegen", | |||
"BulletResist", | |||
"TechResist", | |||
"CritDamageReceivedScale", | |||
"MaxMoveSpeed", | |||
"SprintSpeed", | |||
"StaminaCooldown", | |||
"Stamina" | |||
} | |||
} | } | ||
Line 383: | Line 480: | ||
for hero_key, hero_data in pairs(heroes_data) do | for hero_key, hero_data in pairs(heroes_data) do | ||
-- Ensure they are not in development and they are an active hero | -- Ensure they are not in development and they are an active hero | ||
in_development = hero_data[" | in_development = hero_data["InDevelopment"] | ||
is_disabled = hero_data[" | is_disabled = hero_data["IsDisabled"] | ||
if ( | if (not is_disabled) then | ||
--Add the row's stats | --Add the row's stats | ||
row_str = "" | row_str = "" | ||
-- Retrieve hero's name | -- Retrieve hero's localized name | ||
hero_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 | -- First column in each row is hero name | ||
row_str = row_str .. "<td>" .. | row_str = row_str .. "<td>" .. hero_icon .. "</td>" | ||
-- Consecutive columns are then stats | -- Consecutive columns are then stats | ||
Line 402: | Line 508: | ||
-- Iterate attributes within the category | -- Iterate attributes within the category | ||
for _, attr_key in ipairs( | if (stats_to_include[category] ~= nil) then | ||
for _, attr_key in ipairs(stats_to_include[category]) do | |||
--Retrieve the stats value from hero data | --Retrieve the stats value from hero data | ||
stat_value = hero_data[attr_key] | stat_value = hero_data[attr_key] | ||
if (stat_value == nil) then stat_value = 0 end | if (stat_value == nil) then stat_value = 0 end | ||
-- | -- Retrieve scaling val and str if it scales | ||
stat_value = util_module.round_to_sig_fig(stat_value, 3) | local scaling_data = p.get_hero_scalar(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.get_hero_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 | -- Add it to the row | ||
row_str = row_str .. "<td>" .. stat_value .. "</td>" | row_str = row_str .. "<td>" .. stat_value .. scaling_strs .. "</td>" | ||
end | end | ||
end | end | ||
Line 431: | Line 569: | ||
local header_style = "" | local header_style = "" | ||
local category_data = attribute_module.get_category_data() | 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"] = "", | |||
["SpinAcceleration"] = "BonusFireRate_postfix", | |||
["SpinDeceleration"] = "BonusFireRate_postfix" | |||
} | |||
-- Iterate stats again for displaying headers with their respective color | -- Iterate stats again for displaying headers with their respective color | ||
Line 438: | Line 590: | ||
-- Iterate attributes within the category | -- Iterate attributes within the category | ||
for _, attr_key in ipairs( | if (stats_to_include[category] ~= nil) then | ||
for _, attr_key in ipairs(stats_to_include[category]) do | |||
attr_data = category_attrs[attr_key] | attr_data = category_attrs[attr_key] | ||
-- Localize, fallback to 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 .. ') ;"' | header_style = ' style="background-color: ' .. "rgb(" .. category_rgb .. ') ;"' | ||
headers_str = headers_str .. "<th" .. header_style .. ">" .. attr_localized .. "</th>" | headers_str = headers_str .. "<th" .. header_style .. ">" .. attr_localized .. postfix .. "</th>" | ||
end | end | ||
end | end | ||
Line 454: | Line 625: | ||
headers_str = "<tr>" .. headers_str .. "</tr>" | 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 | |||
end | end | ||
return p | return p |