Module:Icons: Difference between revisions

From Melvor Idle
(added a bunch of extension overrides)
m (Fix extension override handling for skill reqs)
 
(194 intermediate revisions by 12 users not shown)
Line 1: Line 1:
--You can't generate Templates from within Lua due to the loading order, so instead copying the Icon functionality into a module so it can be pulled elsewhere.
local Shared = require("Module:Shared")
--Should function very similarly to how Template:Icon works
local Num = require('Module:Number')
local Overrides = require('Module:Icons/Overrides')
-- Locally index some functions for performance
local sgsub, fixPagename, formatnum, tostring, type = string.gsub, Shared.fixPagename, Num.formatnum, tostring, type


local p = {}
local p = {}
--Extension overrides for items that have non-svg images
local extOverrides = {
  ["Crown of Rhaelyx"] = "png",
  ["Jewel of Rhaelyx"] = "png",
  ["Circlet of Rhaelyx"] = "png",
  ["Charge Stone of Rhaelyx"] = "png",
  ["Mysterious Stone"] = "png",
  ["Cloudburst Staff"] = "png",
  ["Earth Layered Shield"] = "png",
  ["Lemon"] = "jpg",
  ["Lemons"] = "jpg",
  ["Lemonade"] = "jpg",
  ["Miolite Sprig"] = "png",
  ["Miolite Trio"] = "png",
  ["Miolite Warden"] = "png",
  ["Miolite Monarch"] = "png",
  ["Wicked Greater Dragon"] = "png",
  ["Hunting Greater Dragon"] = "png",
  ["Chaotic Greater Dragon"] = "png",
  ["Beavis"] = "png",
  ["Pudding Duckie"] = "png",
  ["Pyro"] = "png",
  ["Snek"] = "png",
  ["Larry, the Lonely Lizard"] = "png",
  ["Caaarrrlll"] = "png",
  ["Gronk"] = "png",
  ["Finn, the Cat"] = "png",
  ["Marahute"] = "png",
  ["Monk-ey"] = "png",
  ["Asura"] = "png",
  ["Summoning Shard (Silver)"] = "png",
  ["Summoning Shard (Red)"] = "png",
  ["Summoning Shard (Green)"] = "png",
  ["Summoning Shard (Gold)"] = "png",
  ["Summoning Shard (Blue)"] = "png",
  ["Summoning Shard (Black)"] = "png",
  ['Infernal Core'] = 'png',
  ['Cool Glasses'] = 'png',
  ['Whale (Perfect)'] = 'png',
  ['Trout (Perfect)'] = 'png',
  ["Thief's Moneysack"] = 'png',
  ['Swordfish (Perfect)'] = 'png',
  ['Strawberry Cupcake (Perfect)'] = 'png',
  ['Strawberry Cake (Perfect)'] = 'png',
  ['Stack of Bones'] = 'png',
  ['Shrimp (Perfect)'] = 'png',
  ['Shark (Perfect)'] = 'png',
  ['Seahorse (Perfect)'] = 'png',
  ['Sardine (Perfect)'] = 'png',
  ['Salmon (Perfect)'] = 'png',
  ['Runecrafting Pouch'] = 'png',
  ['Ring of Wealth'] = 'png',
  ['Raw Beef'] = 'png',
  ['Plain Pizza Slice (Perfect)'] = 'png',
  ['Pile of Ores'] = 'png',
  ['Pile of Logs'] = 'png',
  ['Meat Pizza Slice (Perfect)'] = 'png',
  ['Manta Ray (Perfect)'] = 'png',
  ['Lobster (Perfect)'] = 'png',
  ['Lemon Cake (Perfect)'] = 'png',
  ["Knight's Defender"] = 'png',
  ['Herring (Perfect)'] = 'png',
  ['Hearty Soup (Perfect)'] = 'png',
  ['Fishing Hook'] = 'png',
  ['Fine Coinpurse'] = 'png',
  ['Fanfish (Perfect)'] = 'png',
  ['Cream Corn Soup (Perfect)'] = 'png',
  ['Crate of Food'] = 'png',
  ['Crate of Basic Supplies'] = 'png',
  ['Crab (Perfect)'] = 'png',
  ['Chicken Soup (Perfect)'] = 'png',
  ['Chicken (Perfect)'] = 'png',
  ['Chest of Gems'] = 'png',
  ['Cherry Cupcake (Perfect)'] = 'png',
  ["Chef's Spoon"] = 'png',
  ["Chef's Hat"] = 'png',
  ['Cave Fish (Perfect)'] = 'png',
  ['Carrot Cake (Perfect)'] = 'png',
  ['Carp (Perfect)'] = 'png',
  ['Bread (Perfect)'] = 'png',
  ['Book of Scholars'] = 'png',
  ['Beef Pie (Perfect)'] = 'png',
  ['Beef Pie'] = 'png',
  ['Beef (Perfect)'] = 'png',
  ['Beef'] = 'png',
  ['Basic Soup (Perfect)'] = 'png',
  ['Bag of Flour'] = 'png',
  ['Apple Pie (Perfect)'] = 'png',
  ['Anglerfish (Perfect)'] = 'png',
  ['Amulet of Incantation'] = 'png',
  ['Absorbing Shield'] = 'png',
}


--Extension overrides for items that have non-png images
--Name level overrides take precedence over type level overrides
local extOverrides = Overrides.extOverrides()
--Some overrides only apply for a specific type
local typeExtOverrides = Overrides.typeExtOverrides()
--When calling for an icon of type Key, instead use type Value
--When calling for an icon of type Key, instead use type Value
local typeOverrides = {
local typeOverrides = Overrides.typeOverrides()
  ['combat'] = 'combatArea',
--When calling for an icon for Key, replace with image Value, and optionally override type also
  ['slayer'] = 'combatArea',
local imgOverrides = Overrides.imgOverrides()
}
--When calling for an icon for Key + Type, replace with image Value, and optionally override type also
--When calling for an icon for Key, replace with image Value
local typeImgOverrides = Overrides.typeImgOverrides()
local imgOverrides = {
  ['Alt Magic'] = 'Magic',
  ['Alt. Magic'] = 'Magic',
  ['Alternative Magic'] = 'Magic',
  ['Melee'] = 'Combat',
  ['Spider (lv. 51)'] = 'Spider',
  ['Spider (lv. 52)'] = 'Spider2',
  ['Basic Resupply'] = 'Lobster',
  ['Standard Resupply'] = 'Crab',
  ['Generous Resupply'] = 'Shark'
}
--When calling for an icon for Key, the link goes to Value
--When calling for an icon for Key, the link goes to Value
local linkOverrides = {
local linkOverrides = Overrides.linkOverrides()
  ['Alt Magic'] = 'Alternative Magic',
--When calling for an icon for Key + Type, the link goes to Value
  ['Alt. Magic'] = 'Alternative Magic',
local typeLinkOverrides = Overrides.typeLinkOverrides()
  ['Spider'] = 'Spider (lv. 51)',
-- If no other text override was specified for the given link, use these
  ['Spider2'] = 'Spider (lv. 52)'
local txtOverrides = Overrides.txtOverrides()
}
-- Ambiguous overrides section
--If no other text override was specified for the given link, use these
local ambiguousOverrides = Overrides.ambiguousOverrides()
local txtOverrides = {
-- For ambiguous overrides, determines the type text to be used in the page link
  ['Spider'] = 'Spider (lv. 51)',
local ambiguousTypeMap = Overrides.ambiguousTypeMap()
  ['Spider2'] = 'Spider (lv. 52)'
local currencyFormatDefn = Overrides.currencyFormatDefn()
}
--Ambiguous overrides section
local ambiguousOverrides = {'Golbin', 'Chick'}


local Shared= require("Module:Shared")
-- Defines icon types for which a section or anchor on a static page should be linked to, rather
-- than the usual page linking
local sectionLinks = Overrides.sectionLinks()


function p.Icon(frame)
function p.Icon(frame)
  local args = frame.args ~= nil and frame.args or frame
local args = frame.args ~= nil and frame.args or frame
  local link = args[1]
local link = args[1]
  local text = args[2]
local text = args[2]
  local type = args.type
local iconType = args.type
  local ext = args.ext ~= nil and args.ext or 'svg'
local ext = args.ext ~= nil and args.ext ~= '' and args.ext or 'png'
  local notext = args.notext ~= nil and args.notext ~= ''
local notext = args.notext ~= nil and args.notext ~= ''
  local nolink = args.nolink ~= nil and args.nolink ~= ''
local nolink = args.nolink ~= nil and args.nolink ~= ''
  local menu = args.menu ~= nil and args.menu ~= ''
local noicon = args.noicon ~= nil and args.noicon ~= ''
  local imgSize = args.size ~= nil and args.size or 25
local nospan = args.nospan ~= nil and args.nospan
  local qty = args.qty
local menu = args.menu ~= nil and args.menu ~= ''
  local img = args.img ~= nil and args.img or link
local imgSize = args.size ~= nil and args.size or 25
local qty = args.qty
local img = args.img ~= nil and args.img ~= '' and args.img or link
local class = args.class ~= nil and args.class ~= '' and args.class or ''
local altText = args.alt ~= nil and args.alt or (notext and (text or link)) or ''
local linkSection = args.section
local expIcon = args.expicon ~= nil and args.expicon or ''


  link = string.gsub(link, "%%27", "'")
link = fixPagename(link)
  link = string.gsub(link, "'", "'")
img = fixPagename(img)
  link = string.gsub(link, "'", "'")
  img = string.gsub(img, "%%27", "'")
  img = string.gsub(img, "'", "'")
  img = string.gsub(img, "'", "'")


  img = string.gsub(img, '#', '')
img = sgsub(img, '#', '')
  link = string.gsub(link, '#', '')
img = sgsub(img, '/Training', '')
  --MANUAL OVERRIDES
img = sgsub(img, '/Guide', '')
  if imgOverrides[link] ~= nil and img == link then
img = sgsub(img, '/Boosts', '')
    img = imgOverrides[link]
-- Remove '#' from links to facilitate linking to things with hashes in
  end
-- their names (e.g. item 'Birthday Cake Piece #1'). Links to sections
  if text == nil and txtOverrides[link] ~= nil then
-- of a page should instead be performed using the 'section' parameter.
    text = txtOverrides[link]
link = sgsub(link, '#', '')
  end
  if linkOverrides[link] ~= nil then
    if text == nil then text = link end
    link = linkOverrides[link]
  end
  if extOverrides[img] ~= nil then
    ext = extOverrides[img]
  elseif type == 'mark' then
    ext = 'png'
  end
  if typeOverrides[type] ~= nil then
    type = typeOverrides[type]
  end
  --There are a couple specific double overrides I want to include that don't fit in the above lists
  if Shared.contains(ambiguousOverrides, link) then
    if text == nil then text = link end
    link = link..' ('..type..')'
  end


  --Creating the image...
-- Handle types for which links should be to a section of a static page
  local result = '[[File:'..img
local sl = sectionLinks[iconType]
  --Add in type if one is set
if sl ~= nil and not sl.exclude[link] then
  if type ~= nil and type ~= '' then result = result..'_('..type..')' end
if text == nil or text == '' then
  --Add in extension and image size
text = link
  result = result..'.'..ext..'|'..tostring(imgSize)..'x'..tostring(imgSize)..'px'
end
  --Include a link unless no link -and- no text was requested
linkSection = string.gsub(link, ' ', '')
  if not (nolink and notext) then result = result..'|link='..link end
-- Link overwriting must occur after text & linkSection have been set
  result = result..']]'
link = sl.link
 
if sl.img ~= nil then
  --Add Quantity to the front if requested
img = sl.img[1]
  if qty ~= nil and qty ~= '' then result = Shared.formatnum(qty)..' '..result end
if sl.img[2] ~= nil then
iconType = sl.img[2]
end
end
end


  if not notext then  
--MANUAL OVERRIDES
    if nolink then
local origType = iconType
      if text ~= nil and text ~= '' then
local ovrImg = imgOverrides[link]
        result = result..' '..text
local ovrTypeImg = typeImgOverrides[iconType]
      else
if ovrTypeImg ~= nil then
        result = result..' '..link
ovrImg = ovrTypeImg ~= nil and ovrTypeImg[img] or ovrImg
      end
end
    else
local ovrTxt = txtOverrides[link]
      result = result..' [['..link
local ovrLink = linkOverrides[link]
      if text ~= nil and text ~= '' and text ~= link then
local ovrTypeLink = typeLinkOverrides[iconType]
        result = result..'|'..text
if ovrTypeLink ~= nil and ovrTypeLink[img] ~= nil then
      end
if ovrTypeLink[img] == '' then
      result = result..']]'
nolink = true
    end
else
  end
ovrLink = ovrTypeLink[img]
end
end
local hasText = (text ~= nil and text ~= '')
if ovrImg ~= nil and img == link then
if type(ovrImg) == 'string' then
img = ovrImg
elseif type(ovrImg) == 'table' then
img = ovrImg[1]
if ovrImg[2] ~= nil then iconType = ovrImg[2] end
end
end
 
-- Type & extension overrides must be after adjustments have been made
-- for any image overrides
local ovrTypeExt, ovrTypeExtTable = nil, typeExtOverrides[iconType]
if ovrTypeExtTable ~= nil then
ovrTypeExt = ovrTypeExtTable[img]
end
local ovrType = typeOverrides[iconType]
local ovrExt = extOverrides.name[img]
if ovrExt == nil then
ovrExt = extOverrides.type[ovrType or iconType]
end
if not hasText and ovrTxt ~= nil then
text = ovrTxt
hasText = true
end
if ovrLink ~= nil then
if not hasText then
text = link
hasText = true
end
link = ovrLink
end
if ovrTypeExt ~= nil then
ext = ovrTypeExt
elseif ovrExt ~= nil then
ext = ovrExt
end
if ovrType ~= nil then
iconType = ovrType
end
 
-- There are a couple specific double overrides to be included that don't fit in the above lists
 
-- If the link requires disambiguation or a section, the modify the link accordingly
-- while preserving the displayed text
local isAmbig, hasSection = ambiguousOverrides[link], linkSection ~= nil and linkSection ~= ''
if isAmbig or hasSection then
if not hasText then
text = link
hasText = true
end
if isAmbig then
link = link .. ' (' .. (ambiguousTypeMap[origType] or origType) .. ')'
end
if hasSection then
link = link .. '#' .. linkSection
end
end
 
local resultText = ''
if not noicon then
-- Image size
local txtSize = tostring(imgSize)
-- Extension and type if one is set
local txtImg = (iconType ~= nil and iconType ~= '' and img .. '_(' .. iconType .. ')' or img) .. '.' .. ext
-- Include a link unless no link -and- no text was requested
local txtLink = '|link=' .. (nolink and '' or link)
resultText = '[[File:' .. txtImg .. '|' .. txtSize .. 'x' .. txtSize .. 'px|alt=' .. altText .. txtLink .. ']]'
if class ~= nil and class ~= '' then
resultText = '<span class="'..class..'">'..resultText..'</span>'
end
end


  result = '<span style="display:inline-block">'..result..'</span>'
if not notext then
if nolink then
resultText = resultText .. (noicon and '' or ' ') .. (hasText and text or link)
else
resultText = resultText .. (noicon and '' or ' ') .. '[[' .. link .. (hasText and text ~= link and '|' .. text or '') .. ']]'
end
end


  if menu then
-- Add Quantity to the front if requested
    result = '{| class="articletable" style="display:inline-block;vertical-align:middle;"\r\n|-\r\n|'..result
--local resultQty = (qty ~= nil and qty ~= '' and formatnum(qty) .. ' ' or '')
    result = result..'\r\n|}'
if qty ~= nil and qty ~= '' then
  end
resultText = formatnum(qty) .. ' ' .. resultText
end


  return result
if menu then
return '{| class="articletable img-text" style="vertical-align:middle;"\r\n|-\r\n|' .. expIcon .. resultText .. '\r\n|}'
elseif not noicon and not nospan then
return '<span class="img-text">' .. expIcon .. resultText .. '</span>'
else
return resultText
end
end
end


function p._SkillReq(skill, level, showText)
-- Returns a skill icon based on the realm.
  local result = p.Icon({skill, type='skill', notext='true'})
function p._SkillRealmIcon(skill, realmID, size)
  if showText then
local realm = realmID or 'melvorD:Melvor'
    result = result..' [['..skill..']]'
local link = fixPagename(skill)
  end
  result = result.." Level "..level


  result = '<span style="display:inline-block">'..result..'</span>'
local img = mw.html.create('span')
  return result
if realm == 'melvorItA:Abyssal' then
img:addClass('abyss-icon')
end
size = size or 25
img :wikitext('[[File:'):wikitext(link):wikitext('_(skill).png')
:wikitext('|'):wikitext(size):wikitext('x'):wikitext(size):wikitext('px')
:wikitext('|link='):wikitext(link):wikitext(']]')
return tostring(img)
end
end


function p.SkillReq(frame)
function p.SkillRealmIcon(frame)
  local args = frame.args ~= nil and frame.args or frame
local args = frame.args ~= nil and frame.args or frame
  local skill = args[1]
local skill = args[1]
  local level = tonumber(args[2])
local realmID = args.realm
  local showText = args.showText ~= nil and args.showText ~= '' and args.showText ~= 'false'
local size = tonumber(args.size)
  return p._SkillReq(skill, level, showText)
return p._SkillRealmIcon(skill, realmID, size)
end
 
function p._SkillReq(skill, level, showText, realmID)
local realm = realmID or 'melvorD:Melvor'
local link = fixPagename(skill)
local altText = (showText and '') or skill
if level == nil then
level = 'Unknown [[Category:Pages with script errors]]'
end
 
-- Create skill image.
local img = mw.html.create()
if realm == 'melvorItA:Abyssal' then
img = img:tag('span')
:addClass('abyss-icon')
end
img :wikitext('[[File:'):wikitext(link):wikitext('_(skill).png')
:wikitext('|25x25px|link='):wikitext(link)
:wikitext('|alt='):wikitext(altText)
:wikitext(']]')
-- Create text and add image.
local text = mw.html.create('span')
:addClass('img-text')
:node(img)
if showText == true then
text:wikitext(' [[' .. link .. ']]')
end
--28/06/2024. Commented this out to try out red icons for abyssal levels
-- as opposed to the text below. Remove entire section if still commented out after
-- a week or two.
--if realm == 'melvorItA:Abyssal' then
-- text:wikitext(" Abyssal Level ")
--else
text:wikitext(" Level ")
--end
text:wikitext(level)
return tostring(text)
end
end


function p._MasteryReq(itemName, level, showText)
function p._MasteryReq(itemName, level, showText)
  local iconname = itemName
local iconname = itemName
  local linkname = itemName
local linkname = itemName
  --First, go with the lowest tier of potions if a potion is mentioned
--First, go with the lowest tier of potions if a potion is mentioned
  local s, e = string.find(itemName, 'Potion')
local s, e = string.find(itemName, 'Potion')
  if e ~= nil then
if e ~= nil then
    linkname = string.sub(itemName, 1, e)
linkname = string.sub(itemName, 1, e)
    iconname = linkname..' I'
iconname = linkname..' I'
  end
end
local altTextItem = (showText and '') or linkname
local altTextMastery = (showText and '') or '&nbsp;Mastery'


  local result = 'Level '..level..' '
    local result = mw.html.create('span')
  result = result..p.Icon({linkname, img=iconname, type='item', notext = true})..p.Icon({'Mastery', notext=true})
    result
  if showText then result = result..'[['..linkname..']] [[Mastery]]' end
        :addClass('img-text')
  result = '<span style="display:inline-block">'..result..'</span>'
        :wikitext('Level ' .. level .. ' ')
  return result
        :node(p.Icon({linkname, img=iconname, type='item', notext=true, nospan=true, alt=altTextItem}))
        :node('[[File:Mastery.svg|25x25px|alt=' .. altTextMastery .. ']]')
 
    if showText then
        result
            :wikitext('[[' .. linkname .. ']] ')
            :wikitext('[[Mastery]]')
    end
 
    return tostring(result)
end
end


function p.MasteryReq(frame)
function p._Currency(currencyID, amount, maxAmount)
  local args = frame.args ~= nil and frame.args or frame
local currencyDefn = currencyFormatDefn[currencyID]
  local itemName = args[1]
if currencyDefn == nil then
  local level = tonumber(args[2])
error('Invalid currency ID: ' .. currencyID, 2)
  local showText = args.showText ~= nil and args.showText ~= '' and args.showText ~= 'false'
end
  return p._MasteryReq(itemName, level, showText)
 
local fileName, link, altText = currencyDefn.img, currencyDefn.name, currencyDefn.abbr
 
local function numColour(amount)
if tonumber(amount) < 0 then
return mw.html.create('span')
:css('color', 'red')
:wikitext(formatnum(amount))
:done()
else
return formatnum(amount)
end
end
local html = mw.html.create('span')
:addClass('img-text')
 
-- Currency amounts
if tonumber(amount) ~= nil then
local text = mw.html.create('span')
:css('margin-right', '0.2em')
:node(numColour(amount))
if (tonumber(maxAmount) ~= nil and maxAmount > amount) then
text:wikitext(' - ' .. numColour(maxAmount))
end
html:node(text:done())
end
-- Currency icon
if fileName ~= nil then
html:wikitext('[[File:'):wikitext(fileName):wikitext('|25px')
if link ~= nil then
html:wikitext('|link='):wikitext(link)
end
html:wikitext('|alt=')
:wikitext(((altText == nil and '') or altText))
:wikitext(']]')
end
html:done()
if ((amount ~= nil and tonumber(amount) == nil)
or (maxAmount ~= nil and tonumber(maxAmount) == nil)) then
html:wikitext('[[Category:Pages with non-numeric currency arguments]]')
end
return tostring(html)
end
 
-- p.Currency() is called by various currency templates:
-- [[Template:GP]], [[Template:SC]], [[Template:RC]]
function p.Currency(frame)
local args = frame.args ~= nil and frame.args or frame
local currID, minVal, maxVal, _
currID = args[1]
if args[2] ~= nil and args[2] ~= '' then
minVal, _ = string.gsub(args[2], ',', '')
end
if args[3] ~= nil and args[3] ~= '' then
maxVal, _ = string.gsub(args[3], ',', '')
end
return p._Currency((currID or 'nil'), minVal, maxVal)
end
end


function p._Currency(fileName, link, amt, maxAmt)
--Adding a shortcut function for this
  local amtText = Shared.formatnum(amt)
function p.TotH()
  if maxAmt ~= nil and maxAmt >= amt then
return '<span class="img-text">[[File:TotH.svg|25x25px|link=Throne of the Herald Expansion]]</span>'
    amtText = amtText .. ' - ' .. Shared.formatnum(maxAmt)
end
  end


  local fileText = ''
function p.AoD()
  if fileName ~= nil then
return '<span class="img-text">[[File:AoD.png|25x25px|link=Atlas of Discovery Expansion]]</span>'
    fileText = '[[File:' .. fileName .. '|25px'
end
    if link ~= nil then
 
      fileText = fileText .. '|link=' .. link
function p.ItA()
    end
return '<span class="img-text">[[File:ItA.png|25x25px|link=Into the Abyss Expansion]]</span>'
    fileText = fileText .. ']]&nbsp;'
end
  end


  return '<span style="display:inline-block">' .. fileText .. amtText .. '</span>'
function p.Melvor()
return '<span class="img-text">[[File:Melvor_Logo.svg|25x25px|link=Full Version]]</span>'
end
end


function p.GP(amt, maxamt)
-- Function to retrieve the DLC id used for sorting columns that contain a DLC icon.
  return p._Currency('Coins.svg', 'Coins', amt, maxamt)
-- Passthrough from shared so that caller doesn't have to include Shared Module
function p.getExpansionID(id)
return Shared.getLocalID(id)
end
end


function p.SC(amt, maxamt)
function p.getExpansionIcon(id)
  return p._Currency('Slayer Coins.svg', 'Currency#Slayer Coins', amt, maxamt)
local ns, _ = Shared.getLocalID(id)
if ns == 'melvorTotH' then
return p.TotH()..' '
elseif ns == 'melvorAoD' then
return p.AoD()..' '
elseif ns == 'melvorItA' then
return p.ItA()..' '
else
return ''
end
end
end


function p.RC(amt, maxamt)
-- Special function that returns a Melvor idle icon
  return p._Currency('Raid_Coins.svg', 'Currency#Raid Coins', amt, maxamt)
-- Specifically used for a "DLC" column on tables.
-- Avoids every item from receiving the "base game icon"
function p.getDLCColumnIcon(id)
local icon = p.getExpansionIcon(id)
if icon == '' then
icon = p.Melvor() .. ' '
end
return icon
end
end


return p
return p

Latest revision as of 20:57, 26 August 2024

Documentation for this module may be created at Module:Icons/doc

local Shared = require("Module:Shared")
local Num = require('Module:Number')
local Overrides = require('Module:Icons/Overrides')
-- Locally index some functions for performance
local sgsub, fixPagename, formatnum, tostring, type = string.gsub, Shared.fixPagename, Num.formatnum, tostring, type

local p = {}

--Extension overrides for items that have non-png images
--Name level overrides take precedence over type level overrides
local extOverrides = Overrides.extOverrides()
--Some overrides only apply for a specific type
local typeExtOverrides = Overrides.typeExtOverrides()
--When calling for an icon of type Key, instead use type Value
local typeOverrides = Overrides.typeOverrides()
--When calling for an icon for Key, replace with image Value, and optionally override type also
local imgOverrides = Overrides.imgOverrides()
--When calling for an icon for Key + Type, replace with image Value, and optionally override type also
local typeImgOverrides = Overrides.typeImgOverrides()
--When calling for an icon for Key, the link goes to Value
local linkOverrides = Overrides.linkOverrides()
--When calling for an icon for Key + Type, the link goes to Value
local typeLinkOverrides = Overrides.typeLinkOverrides()
-- If no other text override was specified for the given link, use these
local txtOverrides = Overrides.txtOverrides()
-- Ambiguous overrides section
local ambiguousOverrides = Overrides.ambiguousOverrides()
-- For ambiguous overrides, determines the type text to be used in the page link
local ambiguousTypeMap = Overrides.ambiguousTypeMap()
local currencyFormatDefn = Overrides.currencyFormatDefn()

-- Defines icon types for which a section or anchor on a static page should be linked to, rather
-- than the usual page linking
local sectionLinks = Overrides.sectionLinks()

function p.Icon(frame)
	local args = frame.args ~= nil and frame.args or frame
	local link = args[1]
	local text = args[2]
	local iconType = args.type
	local ext = args.ext ~= nil and args.ext ~= '' and args.ext or 'png'
	local notext = args.notext ~= nil and args.notext ~= ''
	local nolink = args.nolink ~= nil and args.nolink ~= ''
	local noicon = args.noicon ~= nil and args.noicon ~= ''
	local nospan = args.nospan ~= nil and args.nospan
	local menu = args.menu ~= nil and args.menu ~= ''
	local imgSize = args.size ~= nil and args.size or 25
	local qty = args.qty
	local img = args.img ~= nil and args.img ~= '' and args.img or link
	local class = args.class ~= nil and args.class ~= '' and args.class or ''
	local altText = args.alt ~= nil and args.alt or (notext and (text or link)) or ''
	local linkSection = args.section
	local expIcon = args.expicon ~= nil and args.expicon or ''

	link = fixPagename(link)
	img = fixPagename(img)

	img = sgsub(img, '#', '')
	img = sgsub(img, '/Training', '')
	img = sgsub(img, '/Guide', '')
	img = sgsub(img, '/Boosts', '')
	-- Remove '#' from links to facilitate linking to things with hashes in
	-- their names (e.g. item 'Birthday Cake Piece #1'). Links to sections
	-- of a page should instead be performed using the 'section' parameter.
	link = sgsub(link, '#', '')

	-- Handle types for which links should be to a section of a static page
	local sl = sectionLinks[iconType]
	if sl ~= nil and not sl.exclude[link] then
		if text == nil or text == '' then
			text = link
		end
		linkSection = string.gsub(link, ' ', '')
		-- Link overwriting must occur after text & linkSection have been set
		link = sl.link
		if sl.img ~= nil then
			img = sl.img[1]
			if sl.img[2] ~= nil then
				iconType = sl.img[2]
			end
		end
	end

	--MANUAL OVERRIDES
	local origType = iconType
	local ovrImg = imgOverrides[link]
	local ovrTypeImg = typeImgOverrides[iconType]
	if ovrTypeImg ~= nil then
		ovrImg = ovrTypeImg ~= nil and ovrTypeImg[img] or ovrImg
	end
	local ovrTxt = txtOverrides[link]
	local ovrLink = linkOverrides[link]
	local ovrTypeLink = typeLinkOverrides[iconType]
	if ovrTypeLink ~= nil and ovrTypeLink[img] ~= nil then
		if ovrTypeLink[img] == '' then
			nolink = true
		else
			ovrLink = ovrTypeLink[img]
		end
	end
	local hasText = (text ~= nil and text ~= '')
	if ovrImg ~= nil and img == link then
		if type(ovrImg) == 'string' then
			img = ovrImg
		elseif type(ovrImg) == 'table' then
			img = ovrImg[1]
			if ovrImg[2] ~= nil then iconType = ovrImg[2] end
		end
	end

	-- Type & extension overrides must be after adjustments have been made
	-- for any image overrides
	local ovrTypeExt, ovrTypeExtTable = nil, typeExtOverrides[iconType]
	if ovrTypeExtTable ~= nil then
		ovrTypeExt = ovrTypeExtTable[img]
	end
	local ovrType = typeOverrides[iconType]
	local ovrExt = extOverrides.name[img]
	if ovrExt == nil then
		ovrExt = extOverrides.type[ovrType or iconType]
	end
	if not hasText and ovrTxt ~= nil then
		text = ovrTxt
		hasText = true
	end
	if ovrLink ~= nil then
		if not hasText then
			text = link
			hasText = true
		end
		link = ovrLink
	end
	if ovrTypeExt ~= nil then
		ext = ovrTypeExt
	elseif ovrExt ~= nil then
		ext = ovrExt
	end
	if ovrType ~= nil then
		iconType = ovrType
	end

	-- There are a couple specific double overrides to be included that don't fit in the above lists

	-- If the link requires disambiguation or a section, the modify the link accordingly
	-- while preserving the displayed text
	local isAmbig, hasSection = ambiguousOverrides[link], linkSection ~= nil and linkSection ~= ''
	if isAmbig or hasSection then
		if not hasText then
			text = link
			hasText = true
		end
		if isAmbig then
			link = link .. ' (' .. (ambiguousTypeMap[origType] or origType) .. ')'
		end
		if hasSection then
			link = link .. '#' .. linkSection
		end
	end

	local resultText = ''
	if not noicon then
		-- Image size
		local txtSize = tostring(imgSize)
		-- Extension and type if one is set
		local txtImg = (iconType ~= nil and iconType ~= '' and img .. '_(' .. iconType .. ')' or img) .. '.' .. ext
		-- Include a link unless no link -and- no text was requested
		local txtLink = '|link=' .. (nolink and '' or link)
		resultText = '[[File:' .. txtImg .. '|' .. txtSize .. 'x' .. txtSize .. 'px|alt=' .. altText .. txtLink .. ']]'
		if class ~= nil and class ~= '' then
			resultText = '<span class="'..class..'">'..resultText..'</span>'
		end
	end

	if not notext then
		if nolink then
			resultText = resultText .. (noicon and '' or ' ') .. (hasText and text or link)
		else
			resultText = resultText .. (noicon and '' or ' ') .. '[[' .. link .. (hasText and text ~= link and '|' .. text or '') .. ']]'
		end
	end

	-- Add Quantity to the front if requested
	--local resultQty = (qty ~= nil and qty ~= '' and formatnum(qty) .. ' ' or '')
	if qty ~= nil and qty ~= '' then
		resultText = formatnum(qty) .. ' ' .. resultText
	end

	if menu then
		return '{| class="articletable img-text" style="vertical-align:middle;"\r\n|-\r\n|' .. expIcon .. resultText .. '\r\n|}'
	elseif not noicon and not nospan then
		return '<span class="img-text">' .. expIcon .. resultText .. '</span>'
	else
		return resultText
	end
end

-- Returns a skill icon based on the realm.
function p._SkillRealmIcon(skill, realmID, size)
	local realm = realmID or 'melvorD:Melvor'
	local link = fixPagename(skill)

	local img = mw.html.create('span')
	if realm == 'melvorItA:Abyssal' then
		img:addClass('abyss-icon')
	end
	
	size = size or 25
	img :wikitext('[[File:'):wikitext(link):wikitext('_(skill).png')
		:wikitext('|'):wikitext(size):wikitext('x'):wikitext(size):wikitext('px')
		:wikitext('|link='):wikitext(link):wikitext(']]')
		
	return tostring(img)
end

function p.SkillRealmIcon(frame)
	local args = frame.args ~= nil and frame.args or frame
	local skill = args[1]
	local realmID = args.realm
	local size = tonumber(args.size)
	return p._SkillRealmIcon(skill, realmID, size)
end

function p._SkillReq(skill, level, showText, realmID)
	local realm = realmID or 'melvorD:Melvor'
	local link = fixPagename(skill)
	local altText = (showText and '') or skill
	if level == nil then 
		level = 'Unknown [[Category:Pages with script errors]]' 
	end

	-- Create skill image.
	local img = mw.html.create()
	
	if realm == 'melvorItA:Abyssal' then
		img = img:tag('span')
				 :addClass('abyss-icon')
	end
	
	img :wikitext('[[File:'):wikitext(link):wikitext('_(skill).png')
		:wikitext('|25x25px|link='):wikitext(link)
		:wikitext('|alt='):wikitext(altText)
		:wikitext(']]')
	
	-- Create text and add image.
	local text = mw.html.create('span')
		:addClass('img-text')
		:node(img)
	
	if showText == true then
		text:wikitext(' [[' .. link .. ']]')
	end
	
	--28/06/2024. Commented this out to try out red icons for abyssal levels
	-- as opposed to the text below. Remove entire section if still commented out after
	-- a week or two.
	--if realm == 'melvorItA:Abyssal' then
	--	text:wikitext(" Abyssal Level ")
	--else
	text:wikitext(" Level ")
	--end
	
	text:wikitext(level)
	return tostring(text)	
end

function p._MasteryReq(itemName, level, showText)
	local iconname = itemName
	local linkname = itemName
	--First, go with the lowest tier of potions if a potion is mentioned
	local s, e = string.find(itemName, 'Potion')
	if e ~= nil then
		linkname = string.sub(itemName, 1, e)
		iconname = linkname..' I'
	end
	local altTextItem = (showText and '') or linkname
	local altTextMastery = (showText and '') or '&nbsp;Mastery'

    local result = mw.html.create('span')
    result
        :addClass('img-text')
        :wikitext('Level ' .. level .. ' ')
        :node(p.Icon({linkname, img=iconname, type='item', notext=true, nospan=true, alt=altTextItem}))
        :node('[[File:Mastery.svg|25x25px|alt=' .. altTextMastery .. ']]')

    if showText then
        result
            :wikitext('[[' .. linkname .. ']] ')
            :wikitext('[[Mastery]]')
    end

    return tostring(result)
end

function p._Currency(currencyID, amount, maxAmount)
	local currencyDefn = currencyFormatDefn[currencyID]
	if currencyDefn == nil then
		error('Invalid currency ID: ' .. currencyID, 2)
	end

	local fileName, link, altText = currencyDefn.img, currencyDefn.name, currencyDefn.abbr

	local function numColour(amount)
		if tonumber(amount) < 0 then
			return mw.html.create('span')
				:css('color', 'red')
				:wikitext(formatnum(amount))
				:done()
		else
			return formatnum(amount)
		end
	end
	
	local html = mw.html.create('span')
		:addClass('img-text')

	-- Currency amounts
	if tonumber(amount) ~= nil then
		local text = mw.html.create('span')
			:css('margin-right', '0.2em')
			:node(numColour(amount))
		if (tonumber(maxAmount) ~= nil and maxAmount > amount) then
			text:wikitext(' - ' .. numColour(maxAmount))
		end
		html:node(text:done())
	end
	
	-- Currency icon
	if fileName ~= nil then
		html:wikitext('[[File:'):wikitext(fileName):wikitext('|25px')
		if link ~= nil then
			html:wikitext('|link='):wikitext(link)
		end
		html:wikitext('|alt=')
			:wikitext(((altText == nil and '') or altText))
			:wikitext(']]')
	end
	html:done()
	
	if ((amount ~= nil and tonumber(amount) == nil)
		or (maxAmount ~= nil and tonumber(maxAmount) == nil)) then
		html:wikitext('[[Category:Pages with non-numeric currency arguments]]')
	end
	
	return tostring(html)
end

-- p.Currency() is called by various currency templates:
--	[[Template:GP]], [[Template:SC]], [[Template:RC]]
function p.Currency(frame)
	local args = frame.args ~= nil and frame.args or frame
	local currID, minVal, maxVal, _
	currID = args[1]
	if args[2] ~= nil and args[2] ~= '' then
		minVal, _ = string.gsub(args[2], ',', '')
	end
	if args[3] ~= nil and args[3] ~= '' then
		maxVal, _ = string.gsub(args[3], ',', '')
	end
	
	return p._Currency((currID or 'nil'), minVal, maxVal)
end

--Adding a shortcut function for this
function p.TotH()
	return '<span class="img-text">[[File:TotH.svg|25x25px|link=Throne of the Herald Expansion]]</span>'
end

function p.AoD()
	return '<span class="img-text">[[File:AoD.png|25x25px|link=Atlas of Discovery Expansion]]</span>'
end

function p.ItA()
	return '<span class="img-text">[[File:ItA.png|25x25px|link=Into the Abyss Expansion]]</span>'
end

function p.Melvor()
	return '<span class="img-text">[[File:Melvor_Logo.svg|25x25px|link=Full Version]]</span>'
end

-- Function to retrieve the DLC id used for sorting columns that contain a DLC icon.
-- Passthrough from shared so that caller doesn't have to include Shared Module
function p.getExpansionID(id)
	return Shared.getLocalID(id)
end

function p.getExpansionIcon(id)
	local ns, _ = Shared.getLocalID(id)
	if ns == 'melvorTotH' then
		return p.TotH()..' '
	elseif ns == 'melvorAoD' then
		return p.AoD()..' '
	elseif ns == 'melvorItA' then
		return p.ItA()..' '
	else
		return ''
	end
end

-- Special function that returns a Melvor idle icon
-- Specifically used for a "DLC" column on tables.
-- Avoids every item from receiving the "base game icon"
function p.getDLCColumnIcon(id)
	local icon = p.getExpansionIcon(id)
	if icon == '' then
		icon = p.Melvor() .. ' '
	end
	return icon
end

return p