Melvor Idle

Module:Equipment/Recommended: Difference between revisions

Module Discussion

Module:Equipment/Recommended (view source)

Revision as of 22:24, 3 June 2022

1,696 bytes added ,  3 June 2022
main: Modify to support 'showDR' and 'imgSize' parameters
(main: Modify to allow passing of plaintext as equipment parameters; consistency of Module variables with other modules)
(main: Modify to support 'showDR' and 'imgSize' parameters)
Line 1: Line 1:
-- Copied from: https://oldschool.runescape.wiki/w/Module:Recommended Equipment
-- Adapted from: https://oldschool.runescape.wiki/w/Module:Recommended Equipment
-- Released under: https://creativecommons.org/licenses/by-nc-sa/3.0/  
-- Released under: https://creativecommons.org/licenses/by-nc-sa/3.0/  


Line 22: Line 22:
{ placement = 11, name = 'ammo', icon = 'Slot_ammo', txt = 'Quiver', link = 'Equipment#Ammunition' },
{ placement = 11, name = 'ammo', icon = 'Slot_ammo', txt = 'Quiver', link = 'Equipment#Ammunition' },
{ placement = 12, name = 'passive', icon = 'Slot_passive', txt = 'Passive', link = 'Combat Passive Slot' },
{ placement = 12, name = 'passive', icon = 'Slot_passive', txt = 'Passive', link = 'Combat Passive Slot', hasStats = false },
{ placement = 13, name = 'familiar1', icon = 'Slot_summon', txt = 'Familiar Left', link = 'Summoning' },
{ placement = 13, name = 'familiar1', icon = 'Slot_summon', txt = 'Familiar Left', link = 'Summoning' },
{ placement = 14, name = 'familiar2', icon = 'Slot_summon', txt = 'Familiar Right', link = 'Summoning' },
{ placement = 14, name = 'familiar2', icon = 'Slot_summon', txt = 'Familiar Right', link = 'Summoning' },
{ placement = 99, name = 'notes', icon = '', txt = "Notes", link = nil }
{ placement = 99, name = 'notes', icon = '', txt = 'Notes', link = '', hasStats = false }
}
}


function p.main(frame)
function p.main(frame)
local args = frame:getParent().args
local args = frame.args --frame:getParent().args
-- Dynamic colspan and N/A generation value
-- Dynamic colspan and N/A generation value
local greatest_row_size = 0
local greatest_row_size = 0
Line 36: Line 37:
-- Have to sort this table or else the order is messed up when you use it
-- Have to sort this table or else the order is messed up when you use it
table.sort(slots, function(a, b) return a.placement < b.placement end)
table.sort(slots, function(a, b) return a.placement < b.placement end)
local showDR = args.showDR ~= nil and string.lower(args.showDR) == 'true'
local Items, statTotal = nil, 0
if showDR then
-- Include the Items module here if necessary, avoids loading the data
-- if the template does not require it
Items = require('Module:Items')
end
local imgSize = 36
if args.imgSize ~= nil and tonumber(args.imgSize) ~= nil then
imgSize = math.max(0, tonumber(args.imgSize))
elseif showDR then
imgSize = 25
end
local function make_row(slot, data, compact)
local function make_row(slot, data, compact)
local tr = mw.html.create('tr')
local tr = mw.html.create('tr')
local sloticon = tr:tag('td')
local sloticon = tr:tag('td')
sloticon:wikitext(string.format('[[File:%s.png|%s|link=%s|36px]]', slot.icon, slot.txt, slot.link))
sloticon:attr('style', 'text-align: center')
:wikitext(string.format('[[File:%s.png|%s|link=%s|%spx]]', slot.icon, slot.txt, slot.link, imgSize))
if compact then
if compact then
sloticon:attr('style', 'padding-bottom: 4px;')
sloticon:attr('style', 'padding-bottom: 4px;')
end
end
for _, v in ipairs(data) do
for _, v in ipairs(data) do
local itemicon = nil
local itemIcon = nil
if string.find(v, '!', 1, true) then
local isPlain = type(string.find(v, '!', 1, true)) == 'number'
if isPlain then
-- ! prefix, treat as plain text
-- ! prefix, treat as plain text
itemicon = string.sub(v, 2, -1)
itemIcon = string.sub(v, 2, -1)
else
else
-- Otherwise treat as an item icon
-- Otherwise treat as an item icon
itemicon = Icons.Icon({v, img=v, type='item'})
itemIcon = Icons.Icon({v, img=v, type='item'})
end
end
local gearname = tr:tag('td'):wikitext(itemicon)
local gearname = tr:tag('td'):wikitext(itemIcon)
if compact then
if compact then
gearname:attr('style', 'padding-left: 12px;')
gearname:attr('style', 'padding-left: 12px;')
end
-- Attempt to obtain DR value if requested
if showDR then
local hasStats = true
if slot.hasStats ~= nil then
hasStats = slot.hasStats
end
local statValue = 0
if hasStats and not isPlain and Items ~= nil then
local item = Items.getItem(v)
if item ~= nil then
statValue = Items._getItemStat(item, 'damageReduction', true)
end
end
statTotal = statTotal + statValue
tr:tag('td'):wikitext(statValue .. '%')
end
end
end
end
Line 80: Line 113:
greatest_row_size = grs
greatest_row_size = grs
end
end
end
if showDR and greatest_row_size > 1 then
-- showDR option is only compatible if a single column of equipment is to be displayed
return 'ERROR: showDR option is incompatible with more than one item per slot'
end
end
Line 90: Line 128:
local compact = true
local compact = true
if args.noheader == nil then
if args.noheader == nil then
local itemHeader = (greatest_row_size > 1 and 'Item (most effective → least effective)') or 'Item'
compact = false
compact = false
parent:addClass('wikitable')
parent:addClass('wikitable stickyHeader')
parent:tag('tr')
local trHead = parent:tag('tr')
trHead:addClass('headerRow-0')
:tag('th'):wikitext('Slot'):done()
:tag('th'):wikitext('Slot'):done()
:tag('th'):attr('colspan', greatest_row_size):wikitext('Item (most effective → least effective)'):done()
:tag('th'):attr('colspan', greatest_row_size):wikitext(itemHeader):done()
if showDR then
trHead:tag('th'):wikitext('DR%'):done()
end
end
end
Line 110: Line 153:
end
end
end
end
if showDR then
-- Total row for displayed stat
parent:tag('tr')
:tag('th'):attr('colspan', 1 + greatest_row_size):wikitext('Total'):done()
:tag('td'):wikitext(statTotal .. '%'):done()
:done()
end
return tostring(parent) .. '\r\n[[Category:Pages with Equipment Recommendations]]'
return tostring(parent) .. '\r\n[[Category:Pages with Equipment Recommendations]]'
end
end
Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/52137"