Module:Sandbox/LVLGive feedback
Jump to navigation
Jump to search
Documentation for this module may be created at Module:Sandbox/LVL/doc
local p = {}
local items_data = mw.loadJsonData("Data:ItemData.json")
local lang_module = require('Module:Lang')
local generic_module = require('Module:GenericData')
local util_module = require('Module:Utilities')
--With debug_mode on, it outputs unprocessed wikitext
--With debug_mode off/unspecified, it processes the wikitext
local function process_debug_mode(wikitext, debug_mode)
if debug_mode == 'true' then
return wikitext
elseif debug_mode == 'false' or debug_mode == nil then
return mw.getCurrentFrame():preprocess(wikitext)
else
return "debug_mode must be 'true' or 'false'"
end
end
--Writes list of items of a certain slot within the min and max soul bounds
-- Each item is wrapped and separated. For example of wrapping/separator, see
-- get_item_nav_bulletpoints. 'sep' should not be combined with 'right_wrap',
-- as the trailing separator should also be removed from the string
local function write_wrapped_item_list(slot, min_souls, max_souls, template, sep)
if slot ~= 'Weapon' and slot ~= 'Armor' and slot ~= 'Tech' then
return 'slot must be Weapon, Armor (Vitality), or Tech (Spirit)'
end
local min_souls = tonumber(min_souls)
local max_souls = tonumber(max_souls)
if min_souls == nil or max_souls == nil then return 'Min/Max souls must be numerical' end
-- Retrieve all items that fit the bounds
local items = {}
for item_key, item_data in pairs(items_data) do
-- future proofing; Disabled will be renamed to IsDisabled soon
local this_cost = tonumber(item_data["Cost"])
local this_slot = item_data["Slot"]
if item_data["Name"] ~= nil and item_data["IsDisabled"] == false and this_cost ~= nil and this_slot ~= nil then
if slot == this_slot and this_cost >= min_souls and this_cost < max_souls then
local item_name_english = lang_module.get_string(item_key, "en") -- Get the English name
local lang_code = lang_module.get_lang_code() -- Get the language code from the subpage
local item_name_local = lang_module.get_string(item_key, lang_code) -- Get the localized name
-- Construct the template based on the type
local item_template
if template == "ItemIcon" then
if lang_code == "en" then
-- For English pages, do not include lang or localized name
item_template = "{{ItemIcon|" .. item_name_english .. "}}"
else
-- For non-English pages, include lang and localized name
item_template = "{{ItemIcon|" .. item_name_english .. "|lang=" .. lang_code .. "|" .. item_name_local .. "}}"
end
elseif template == "ItemBox" then
if lang_code == "en" then
-- For English pages, do not include item_loc or link
item_template = "{{ItemBox|item_name=" .. item_name_english .. "}}"
else
-- For non-English pages, include item_loc and link
local link = item_name_english .. "/" .. lang_code -- Add subpage for non-English languages
item_template = "{{ItemBox|item_name=" .. item_name_english .. "|item_loc=" .. item_name_local .. "|link=" .. link .. "}}"
end
else
return "Invalid template type"
end
table.insert(items, item_template)
end
end
end
-- Order list alphabetically
table.sort(items) -- O(nlogn)
-- Add each item to output
-- Each item is already wrapped in the template, so no need for additional wrapping
local ret = table.concat(items, sep)
return ret
end
-- for [[Template:Item Navbox]]
function p.get_item_nav_bulletpoints(slot, min_souls, max_souls, debug_mode)
-- Handle the case where it's called via #invoke (i.e., from wikitext)
if type(slot) == "table" and slot.args then
local frame = slot
slot = frame.args[1]
min_souls = frame.args[2]
max_souls = frame.args[3]
debug_mode = frame.args["debug_mode"]
end
local sep = ' • '
local item_list = write_wrapped_item_list(slot, min_souls, max_souls, "ItemIcon", sep)
return process_debug_mode(item_list, debug_mode)
end
-- for [[Template:Infobox ShopItems]]
function p.get_item_nav_cards(slot, min_souls, max_souls, debug_mode)
-- Handle the case where it's called via #invoke (i.e., from wikitext)
if type(slot) == "table" and slot.args then
local frame = slot
slot = frame.args[1]
min_souls = frame.args[2]
max_souls = frame.args[3]
debug_mode = frame.args["debug_mode"]
end
local sep = ' '
local item_list = write_wrapped_item_list(slot, min_souls, max_souls, "ItemBox", sep)
return process_debug_mode(item_list, debug_mode)
end
function p.write_item_slot_subgroup(frame)
local slot = frame.args[1]
local type = frame.args[2]
local debug_mode = frame.args['debug_mode']
if slot == nil then return "'slot' parameter is required" end
-- Define base args
local template_title = "Navbox subgroup"
local template_args = {
["groupstyle"] = "background-color:" .. util_module.get_slot_color(slot) .. ";width:10%;min-width:70px;border-radius: 8px 0 0 8px",
["grouppadding"] = "5px",
["listpadding"] = "0 0.25rem",
}
local soul_style = "font-size: 12px; text-shadow: 1px 1px rgba(0, 0, 0, 0.3);"
local prices = generic_module.get_item_price_per_tier()
for i, souls in ipairs(prices) do
--Determine lower bound for soul
min_souls = souls
--Skip 0 to i1 as no items cost less than 500
if min_souls ~= 0 then
-- Determine upper bound
max_souls = prices[i+1]
if max_souls == nil then
max_souls = min_souls * 10 --essentially have no upper bound
end
--Create the subgroup
template_args["group" .. (i-1)] = frame:expandTemplate{title="Souls", args={[1] = min_souls, ["Shadow"] = soul_style}}
local list
if type=='get_item_nav_cards' then
list = p.get_item_nav_cards(slot, min_souls, max_souls, debug_mode)
elseif type=='get_item_nav_bulletpoints' then
list = p.get_item_nav_bulletpoints(slot, min_souls, max_souls, debug_mode)
else
return "'type' should be get_item_nav_cards or get_item_nav_bulletpoints"
end
template_args["list" .. (i-1)] = list
end
end
return frame:expandTemplate{title=template_title, args=template_args}
end
-- for [[Template:Active Items]]
function p.generate_active_items_table(frame)
local active_items = {}
-- 1. Collect active items and their cost
for item_key, item_data in pairs(items_data) do
if item_data["Name"] and
item_data["IsDisabled"] == false and
item_data["Activation"] and
item_data["Activation"] ~= "Passive" then
table.insert(active_items, {
name = item_data["Name"],
key = item_key,
cost = tonumber(item_data["Cost"]) or 0,
slot = item_data["Slot"] or "Weapon",
has_active_desc = item_data["ActiveDescription"] ~= nil
})
end
end
-- 2. Sort by name
table.sort(active_items, function(a, b) return a.name < b.name end)
-- 3. Generate wiki markup
local wikitext = [=[
{| class="wikitable sortable" style="width:100%"
|+{{#invoke:Dictionary|translate|Active Items}}
! colspan="2" | {{#invoke:Lang|get_string|Citadel_HeroBuilds_CategoryNameLabel}}
! {{#invoke:Lang|get_string|Citadel_UserFeedback_TypeLabel}}
! {{Souls|{{#invoke:Dictionary|translate|Cost}}}}
! {{#invoke:Lang|get_string|Citadel_Mod_Tooltip_Active}}
! {{#invoke:Lang|get_string|AbilityCooldown_label}}
]=]
-- 4. Add rows for each item
for _, item in ipairs(active_items) do
-- Determine background color and item type
local bg_color, item_type
if item.slot == "Armor" then
bg_color = "#86C921"
item_type = "Armor"
elseif item.slot == "Tech" then
bg_color = "#DE9CFF"
item_type = "Tech"
else
bg_color = "#FCAC4D"
item_type = "Weapon"
end
-- The cost cell uses 'data-sort-value' to provide a clean number for the client-side sorter,
-- while the cell's visible content is formatted by the {{Souls}} template.
wikitext = wikitext .. "\n" .. string.format([=[
|-
! style="background-color:%s" | [[File:%s.png|64x64px]]
! [[%s{{If_lang}}|{{#invoke:Lang|get_string|%s}}]]
| style="text-align:center;font-weight:bold" | {{ItemType|%s|{{#invoke:Lang|get_string|CitadelCategory%s}}}}
| data-sort-value="%d" style="text-align:center;font-size:15px" | {{Souls|%d}}
| {{#invoke:Utilities|process_variables|%s_active_desc|%s}}{{#invoke:Utilities|process_variables|%s_desc|%s}}{{#invoke:Utilities|process_variables|%s_active|%s}}
| style="text-align:center;font-size:16px" | {{#invoke:ItemData|get_prop|%s|AbilityCooldown}}s
]=],
bg_color,
item.name,
item.name, item.key,
item_type, item_type,
item.cost, item.cost,
item.key, item.name, item.key, item.name, item.key, item.name,
item.name)
end
wikitext = wikitext .. "\n|}"
return frame:preprocess(wikitext)
end
--------------------------------------------------------------------
-- 1. Builds the wikitext for ONE price bracket
--------------------------------------------------------------------
local function write_disabled_item_list(slot, min_souls, max_souls, template, sep)
local t = {}
for k, d in pairs(items_data) do
local cost = tonumber(d.Cost)
if d.Name
and d.IsDisabled == true
and cost
and (slot == "" or d.Slot == slot)
and cost >= min_souls
and cost < max_souls
then
local en = lang_module.get_string(k, "en")
local lc = lang_module.get_lang_code()
local loc = lang_module.get_string(k, lc)
local piece
if template == "ItemBox" then
piece = (lc == "en")
and string.format("{{ItemBox|item_name=%s}}", en)
or string.format("{{ItemBox|item_name=%s|item_loc=%s|link=%s/%s}}",
en, loc, en, lc)
else -- default to ItemIcon
piece = (lc == "en")
and string.format("{{ItemIcon|%s}}", en)
or string.format("{{ItemIcon|%s|lang=%s|%s}}", en, lc, loc)
end
table.insert(t, piece)
end
end
table.sort(t)
return table.concat(t, sep or " ")
end
--------------------------------------------------------------------
-- 2. Entry point that mimics write_item_slot_subgroup for disabled items
--------------------------------------------------------------------
function p.write_disabled_subgroup(frame)
local slot = frame.args[1] or "" -- Weapon / Armor / Tech / ""
local template = frame.args[2] or "ItemBox"
local sep = frame.args.sep or " "
local debug_mode = frame.args.debug_mode
local prices = generic_module.get_item_price_per_tier()
local soul_style = "font-size: 12px; text-shadow: 1px 1px rgba(0,0,0,0.3);"
local args = {
groupstyle = "background-color:" .. util_module.get_slot_color(slot) ..
";width:10%;min-width:70px;border-radius:8px 0 0 8px",
grouppadding = "5px",
listpadding = "0 0.25rem",
}
local idx = 0
for i, souls in ipairs(prices) do
if souls ~= 0 then -- skip 0-500 bracket
local max = prices[i + 1] or souls * 10
args["group" .. idx] =
frame:expandTemplate{title = "Souls",
args = {[1] = souls, Shadow = soul_style}}
args["list" .. idx] =
write_disabled_item_list(slot, min_souls, max_souls, template, sep)
idx = idx + 1
end
end
local out = frame:expandTemplate{title = "Navbox subgroup", args = args}
return process_debug_mode(out, debug_mode)
end
return p