Module:Icons: Difference between revisions

From Melvor Idle
m (Remove local indexing of unused function)
m (Fix extension override handling for skill reqs)
 
(163 intermediate revisions by 8 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.
--Should function very similarly to how Template:Icon works
local Shared = require("Module:Shared")
local Shared = require("Module:Shared")
 
local Num = require('Module:Number')
local Overrides = require('Module:Icons/Overrides')
-- Locally index some functions for performance
-- Locally index some functions for performance
local sgsub, fixPagename, formatnum, tostring, type = string.gsub, Shared.fixPagename, Shared.formatnum, tostring, type
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 = {
["Adventure"] = "png",
["Crown of Rhaelyx"] = "png",
["Jewel of Rhaelyx"] = "png",
["Circlet of Rhaelyx"] = "png",
["Charge Stone of Rhaelyx"] = "png",
["Mysterious Stone"] = "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',
["Wizard's Sigil"] = 'png',
["Wizard's Scroll"] = 'png',
["Whetstone"] = 'png',
["Whale (Perfect)"] = 'png',
["Trout (Perfect)"] = 'png',
["Training Shield"] = 'png',
["Thiever's Cape"] = 'png',
["Thief's Moneysack"] = 'png',
["Swordfish (Perfect)"] = 'png',
["Strawberry Cupcake (Perfect)"] = 'png',
["Strawberry Cupcake"] = 'png',
["Strawberry Cake (Perfect)"] = 'png',
["Strawberry Cake"] = 'png',
["Stack of Bones"] = 'png',
["Sneak-Ers"] = 'png',
["Shrimp (Perfect)"] = 'png',
["Shipwheel"] = 'png',
["Shark (Perfect)"] = 'png',
["Seed Pouch"] = 'png',
["Seahorse (Perfect)"] = 'png',
["Sardine (Perfect)"] = 'png',
["Salmon (Perfect)"] = 'png',
["Sailor's Top"] = 'png',
["Runecrafting Pouch"] = 'png',
["Ring of Wealth"] = 'png',
["Raw Chicken"] = 'png',
["Raw Beef"] = 'png',
["Prayer Scroll"] = 'png',
["Plain Pizza Slice (Perfect)"] = 'png',
["Plain Pizza Slice"] = 'png',
["Pile of Ores"] = 'png',
["Pile of Logs"] = 'png',
["Miner's Helmet"] = 'png',
["Merchant's Permit"] = 'png',
["Meat Pizza Slice (Perfect)"] = 'png',
["Meat Pizza Slice"] = 'png',
["Marksman's Sigil"] = 'png',
["Manta Ray (Perfect)"] = 'png',
["Lumberjack's Top"] = 'png',
["Lobster (Perfect)"] = 'png',
["Lemon Cake (Perfect)"] = 'png',
["Lemon Cake"] = 'png',
["Knight's Sigil"] = 'png',
["Knight's Defender"] = 'png',
["Knight's Cape"] = 'png',
["Jeweled Necklace"] = 'png',
["Jester's Hat"] = 'png',
["Jadestone"] = 'png',
["Herring (Perfect)"] = 'png',
["Hearty Soup (Perfect)"] = 'png',
["Hearty Soup"] = 'png',
["Gold Crested Shield"] = 'png',
["Golbin Mask"] = 'png',
["Giant Club"] = 'png',
["Fishing Hook"] = 'png',
["Fine Coinpurse"] = 'png',
["Fanfish (Perfect)"] = 'png',
["Cream Corn Soup (Perfect)"] = 'png',
["Cream Corn Soup"] = 'png',
["Cream"] = 'png',
["Crate of Food"] = 'png',
["Crate of Basic Supplies"] = 'png',
["Crab (Perfect)"] = 'png',
["Cooking Apron"] = 'png',
["Chicken Soup (Perfect)"] = 'png',
["Chicken Soup"] = 'png',
["Chicken (Perfect)"] = 'png',
["Chest of Gems"] = 'png',
["Cherry Seeds"] = 'png',
["Cherry Cupcake (Perfect)"] = 'png',
["Cherry Cupcake"] = 'png',
["Cherry"] = 'png',
["Chef's Spoon"] = 'png',
["Chef's Hat"] = 'png',
["Cheese"] = 'png',
["Cave Giant Boots"] = 'png',
["Cave Fish (Perfect)"] = 'png',
["Carrot Cake (Perfect)"] = 'png',
["Carrot Cake"] = 'png',
["Carp (Perfect)"] = 'png',
["Bread (Perfect)"] = 'png',
["Bread"] = 'png',
["Book of Scholars"] = 'png',
["Bob's Gloves"] = 'png',
["Beef Pie (Perfect)"] = 'png',
["Beef Pie"] = 'png',
["Beef (Perfect)"] = 'png',
["Beef"] = 'png',
["Basic Soup (Perfect)"] = 'png',
["Basic Soup"] = 'png',
["Basic Bag"] = 'png',
["Bag of Flour"] = 'png',
["Apple Tree Seeds"] = 'png',
["Apple Pie (Perfect)"] = 'png',
["Apple Pie"] = 'png',
["Apple"] = 'png',
["Antique Vase"] = 'png',
["Anglerfish (Perfect)"] = 'png',
["Amulet of Incantation"] = 'png',
["Alchemist's Bag"] = 'png',
["Absorbing Shield"] = 'png',
["Shield of Melee Power"] = 'png',
["Shield of Ranged Power"] = 'png',
["Shield of Magic Power"] = 'png',
["Ring of Power"] = 'png',
["Beginning of the End"] = 'png',
["Goo"] = 'png',
["Wildflower"] = 'png',
["Nature's Call Staff Top"] = 'png',
["Nature's Call Staff Bottom"] = 'png',
["Fine Poison Powder"] = 'png',
["Poison Scales"] = 'png',
["Miolite Spore"] = 'png',
["Poison Essence"] = 'png',
["Worm Spike"] = 'png',
["Burning Essence"] = 'png',
["Cursed Hands"] = 'png',
["Stinging Essence"] = 'png',
["Tough Shell"] = 'png',
["Undead Essence"] = 'png',
["Desecrated Bones"] = 'png',
["War Axe"] = 'png',
["Warberd"] = 'png',
["Throwing Power Gloves"] = 'png',
["Slingshot"] = 'png',
["Elerine Longbow"] = 'png',
["Elerine Spear"] = 'png',
["Nature's Call Staff"] = 'png',
["Nature's Wrath Staff"] = 'png',
["Nature's Blessing Ring"] = 'png',
["Poisoned Shortbow"] = 'png',
["Poisoned Dagger"] = 'png',
["Scaled Shield"] = 'png',
["Poison Virulence Ring"] = 'png',
["Poison Virulence Gloves"] = 'png',
["Burning Madness Ring"] = 'png',
["Burning Madness Gloves"] = 'png',
["Spiked Shell Ring"] = 'png',
["Spiked Shell Gloves"] = 'png',
["Relentless Fury Ring"] = 'png',
["Relentless Fury Gloves"] = 'png',
["Ring of Blade Echoes"] = 'png',
["Ring of Barrage"] = 'png',
["Ring of Spirit Power"] = 'png',
["Hinder Potion I"] = 'png',
["Hinder Potion II"] = 'png',
["Hinder Potion III"] = 'png',
["Hinder Potion IV"] = 'png',
["Famished Potion I"] = 'png',
["Famished Potion II"] = 'png',
["Famished Potion III"] = 'png',
["Famished Potion IV"] = 'png',
["Lethal Toxins Potion I"] = 'png',
["Lethal Toxins Potion II"] = 'png',
["Lethal Toxins Potion III"] = 'png',
["Lethal Toxins Potion IV"] = 'png',
["Impending Darkness"] = 'png',
["Mastery Token (Astrology)"] = 'png',
["Stardust"] = 'png',
["Golden Stardust"] = 'png',
["Astrology Skillcape"] = 'png',
["Secret Stardust Potion I"] = 'png',
["Secret Stardust Potion II"] = 'png',
["Secret Stardust Potion III"] = 'png',
["Secret Stardust Potion IV"] = 'png',
["Noxious Serpent"] = 'png',
["Venomous Snake"] = 'png',
["Legaran Wurm"] = 'png',
["Spiked Red Claw"] = 'png',
["Greater Skeletal Dragon"] = 'png',
["Giant Moth"] = 'png',
["Elerine Mage"] = 'png',
["Elerine Warrior"] = 'png',
["Elerine Archer"] = 'png',
["Cursed Lich"] = 'png',
["Christmas Present (Blue)"] = 'png',
["Christmas Present (Green)"] = 'png',
["Christmas Present (Purple)"] = 'png',
["Christmas Present (Standard)"] = 'png',
["Christmas Present (White)"] = 'png',
["Christmas Present (Yellow)"] = 'png',
["Edible Candy Cane"] = 'png',
["Event Token (Holiday 2021)"] = 'png',
["Gingerbread House"] = 'png',
["Gingerbread Man"] = 'png',
["Holiday Scarf"] = 'png',
["Locked Chest"] = 'png',
["Locked Chest Key"] = 'png',
["Festive Chio"] = 'png',
["Festive Cool Rock"] = 'png',
["Mastery Tokens"] = 'gif',
["Enchanted Topaz Bolts"] = 'png',
["Enchanted Sapphire Bolts"] = 'png',
["Enchanted Ruby Bolts"] = 'png',
["Enchanted Emerald Bolts"] = 'png',
["Enchanted Diamond Bolts"] = 'png',
["Enchanted Jadestone Bolts"] = 'png',
["Poison Ring"] = 'png',
["Burning Ring"] = 'png',
["Frostburn Ring"] = 'png',
["Ultima Godsword"] = 'png',
["Mystery Wand"] = 'png',
["Poison Arrows"] = 'png',
["Fire Arrows"] = 'png',
["Frostburn Arrows"] = 'png',
["Burning Wand"] = 'png',
["Frostburn Wand"] = 'png',
["Ring of Balance"] = 'png',
["Flying Cape"] = 'png',
["Amulet of Healing"] = 'png',
["Sword of Some Reliability"] = 'png',
["One Layer Shield"] = 'png',
["Warding Shield"] = 'png',
["Tilted Crossbow"] = 'png',
["Ultimate Speed Boots"] = 'png',
["Almighty Ring"] = 'png',
["Punching Bag Platebody"] = 'png',
["Precision Gloves"] = 'png',
["Heavy Gloves"] = 'png',
["Ultimate Slapping Gloves"] = 'png',
["Amulet of Burning Leech"] = 'png',
["Amulet of Poison Leech"] = 'png',
["Magic Critical Amulet"] = 'png',
["Melee Critical Amulet"] = 'png',
["Bloodthirst Amulet"] = 'png',
["Dragon Head Helmet"] = 'png',
["Stonewall Shield"] = 'png',
["Impossible Longbow"] = 'png',
["Throwing Dragon Sword"] = 'png',
["Golbin Crate"] = '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
--Some overrides only apply for a specific type
local typeExtOverrides = {
local typeExtOverrides = Overrides.typeExtOverrides()
['item'] = {
['Chicken'] = 'png'
}
}
 
--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',
['slayer'] = 'combatArea',
}
--When calling for an icon for Key, replace with image Value, and optionally override type also
--When calling for an icon for Key, replace with image Value, and optionally override type also
local imgOverrides = {
local imgOverrides = Overrides.imgOverrides()
['Alt Magic'] = 'Magic',
--When calling for an icon for Key + Type, replace with image Value, and optionally override type also
['Alt. Magic'] = 'Magic',
local typeImgOverrides = Overrides.typeImgOverrides()
['Alternative Magic'] = 'Magic',
['Item Alchemy'] = {'Item Alchemy III', 'spell'},
['Superheat'] = {'Superheat IV', 'spell'},
['Melee'] = 'Combat',
['Spider (lv. 51)'] = 'Spider',
['Spider (lv. 52)'] = 'Brown Spider',
['Basic Resupply'] = {'Lobster', 'item'},
['Standard Resupply'] = {'Crab', 'item'},
['Generous Resupply'] = {'Shark', 'item'},
['Cooking Upgrade 1'] = {'Cooking', 'skill'},
['Cooking Upgrade 2'] = {'Cooking', 'skill'},
['Loot Container Stacking'] = {'Amulet of Looting', 'item'},
['Bane, Instrument of Fear'] = 'Bane',
['Mastery Token Astrology'] = 'Mastery Token (Astrology)',
['Event Token - Holiday 2021'] = 'Christmas Present (Yellow)',
["I Can't See Helmet"] = {'Golbin', 'monster'},
-- Overrides that allow generic potion pages to be linked to easily
['Melee Accuracy Potion'] = {'Melee Accuracy Potion I', 'item'},
['Melee Evasion Potion'] = {'Melee Evasion Potion I', 'item'},
['Ranged Assistance Potion'] = {'Ranged Assistance Potion I', 'item'},
['Hinder Potion'] = {'Hinder Potion I', 'item'},
['Magic Assistance Potion'] = {'Magic Assistance Potion I', 'item'},
['Regeneration Potion'] = {'Regeneration Potion I', 'item'},
['Famished Potion'] = {'Famished Potion I', 'item'},
['Ranged Strength Potion'] = {'Ranged Strength Potion I', 'item'},
['Lucky Herb Potion'] = {'Lucky Herb Potion I', 'item'},
['Divine Potion'] = {'Divine Potion I', 'item'},
['Melee Strength Potion'] = {'Melee Strength Potion I', 'item'},
['Magic Damage Potion'] = {'Magic Damage Potion I', 'item'},
['Lethal Toxins Potion'] = {'Lethal Toxins Potion I', 'item'},
['Diamond Luck Potion'] = {'Diamond Luck Potion I', 'item'},
['Damage Reduction Potion'] = {'Damage Reduction Potion I', 'item'},
['Bird Nest Potion'] = {'Bird Nest Potion I', 'item'},
['Controlled Heat Potion'] = {'Controlled Heat Potion I', 'item'},
['Generous Cook Potion'] = {'Generous Cook Potion I', 'item'},
['Fishermans Potion'] = {'Fishermans Potion I', 'item'},
['Skilled Fletching Potion'] = {'Skilled Fletching Potion I', 'item'},
['Gentle Hands Potion'] = {'Gentle Hands Potion I', 'item'},
['Secret Stardust Potion'] = {'Secret Stardust Potion I', 'item'},
['Crafting Potion'] = {'Crafting Potion I', 'item'},
['Perfect Swing Potion'] = {'Perfect Swing Potion I', 'item'},
['Necromancer Potion'] = {'Necromancer Potion I', 'item'},
['Performance Enhancing Potion'] = {'Performance Enhancing Potion I', 'item'},
['Elemental Potion'] = {'Elemental Potion I', 'item'},
['Herblore Potion'] = {'Herblore Potion I', 'item'},
['Generous Harvest Potion'] = {'Generous Harvest Potion I', 'item'},
['Seeing Gold Potion'] = {'Seeing Gold Potion I', 'item'}
}
--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()
['Spider2'] = 'Brown Spider',
-- If no other text override was specified for the given link, use these
["Deedree"] = 'Astrology#Constellations',
local txtOverrides = Overrides.txtOverrides()
["Iridan"] = 'Astrology#Constellations',
-- Ambiguous overrides section
["Ameria"] = 'Astrology#Constellations',
local ambiguousOverrides = Overrides.ambiguousOverrides()
["Terra"] = 'Astrology#Constellations',
-- For ambiguous overrides, determines the type text to be used in the page link
["Vale"] = 'Astrology#Constellations',
local ambiguousTypeMap = Overrides.ambiguousTypeMap()
["Syllia"] = 'Astrology#Constellations',
local currencyFormatDefn = Overrides.currencyFormatDefn()
["Arachi"] = 'Astrology#Constellations',
 
["Ko"] = 'Astrology#Constellations',
-- Defines icon types for which a section or anchor on a static page should be linked to, rather
["Tellus"] = 'Astrology#Constellations',
-- than the usual page linking
["Hyden"] = 'Astrology#Constellations',
local sectionLinks = Overrides.sectionLinks()
["Qimican"] = 'Astrology#Constellations'
}
--If no other text override was specified for the given link, use these
local txtOverrides = {
['Spider2'] = 'Brown Spider'
}
--Ambiguous overrides section
local ambiguousOverrides = {
['Golbin'] = true,
['Chick'] = true,
['Chicken'] = true,
['Cyclops'] = true,
['Wizard'] = true
}


function p.Icon(frame)
function p.Icon(frame)
Line 376: Line 39:
local text = args[2]
local text = args[2]
local iconType = args.type
local iconType = args.type
local ext = args.ext ~= nil and args.ext ~= '' 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 noicon = args.noicon ~= nil and args.noicon ~= ''
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 menu = args.menu ~= nil and args.menu ~= ''
local imgSize = args.size ~= nil and args.size or 25
local imgSize = args.size ~= nil and args.size or 25
local qty = args.qty
local qty = args.qty
local img = args.img ~= nil and args.img ~= '' and args.img or link
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)
link = fixPagename(link)
Line 391: Line 59:
img = sgsub(img, '/Training', '')
img = sgsub(img, '/Training', '')
img = sgsub(img, '/Guide', '')
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, '#', '')
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
--MANUAL OVERRIDES
local origType = iconType
local ovrImg = imgOverrides[link]
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 ovrTxt = txtOverrides[link]
local ovrLink = linkOverrides[link]
local ovrLink = linkOverrides[link]
local ovrTypeExt = typeExtOverrides[iconType]
local ovrTypeLink = typeLinkOverrides[iconType]
if ovrTypeExt ~= nil then
if ovrTypeLink ~= nil and ovrTypeLink[img] ~= nil then
ovrTypeExt = ovrTypeExt[img]
if ovrTypeLink[img] == '' then
nolink = true
else
ovrLink = ovrTypeLink[img]
end
end
end
local ovrExt = extOverrides[img]
local ovrType = typeOverrides[iconType]
local hasText = (text ~= nil and text ~= '')
local hasText = (text ~= nil and text ~= '')
if ovrImg ~= nil and img == link then
if ovrImg ~= nil and img == link then
Line 411: Line 107:
if ovrImg[2] ~= nil then iconType = ovrImg[2] end
if ovrImg[2] ~= nil then iconType = ovrImg[2] end
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
end
if not hasText and ovrTxt ~= nil then
if not hasText and ovrTxt ~= nil then
text = ovrTxt
text = ovrTxt
hasText = true
end
end
if ovrLink ~= nil then
if ovrLink ~= nil then
if not hasText then text = link end
if not hasText then
text = link
hasText = true
end
link = ovrLink
link = ovrLink
end
end
Line 423: Line 135:
elseif ovrExt ~= nil then
elseif ovrExt ~= nil then
ext = ovrExt
ext = ovrExt
elseif iconType == 'mark' then
ext = 'png'
end
end
if ovrType ~= nil then
if ovrType ~= nil then
iconType = ovrType
iconType = ovrType
end
end
-- There are a couple specific double overrides to be included that don't fit in the above lists
-- There are a couple specific double overrides to be included that don't fit in the above lists
if ambiguousOverrides[link] then
 
if not hasText then text = link end
-- If the link requires disambiguation or a section, the modify the link accordingly
link = link..' ('..(iconType == 'mark' and 'item' or iconType)..')'
-- 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
end


Line 442: Line 165:
local txtImg = (iconType ~= nil and iconType ~= '' and img .. '_(' .. iconType .. ')' or img) .. '.' .. ext
local txtImg = (iconType ~= nil and iconType ~= '' and img .. '_(' .. iconType .. ')' or img) .. '.' .. ext
-- Include a link unless no link -and- no text was requested
-- Include a link unless no link -and- no text was requested
local txtLink = (nolink and notext and '' or '|link=' .. link)
local txtLink = '|link=' .. (nolink and '' or link)
resultText = '[[File:' .. txtImg .. '|' .. txtSize .. 'x' .. txtSize .. 'px' .. txtLink .. ']]'
resultText = '[[File:' .. txtImg .. '|' .. txtSize .. 'x' .. txtSize .. 'px|alt=' .. altText .. txtLink .. ']]'
if class ~= nil and class ~= '' then
resultText = '<span class="'..class..'">'..resultText..'</span>'
end
end
end


Line 461: Line 187:


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


-- Wrapper for p.Icon(), uses the same parameters but forces noicon = true
-- Returns a skill icon based on the realm.
function p.Link(frame)
function p._SkillRealmIcon(skill, realmID, size)
local args = frame.args ~= nil and frame.args or frame
local realm = realmID or 'melvorD:Melvor'
args.noicon = true
local link = fixPagename(skill)
return p.Icon({['args'] = args})
end


function p._SkillReq(skill, level, showText)
local img = mw.html.create('span')
local result = p.Icon({skill, type='skill', notext='true'})
if realm == 'melvorItA:Abyssal' then
if showText then
img:addClass('abyss-icon')
result = result..' [['..skill..']]'
end
end
if level == nil then level = 'Unknown [[Category:Pages with script errors]]' end
result = result.." Level "..level
size = size or 25
 
img :wikitext('[[File:'):wikitext(link):wikitext('_(skill).png')
result = '<span style="display:inline-block">'..result..'</span>'
:wikitext('|'):wikitext(size):wikitext('x'):wikitext(size):wikitext('px')
return result
: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


Line 505: Line 273:
iconname = linkname..' I'
iconname = linkname..' I'
end
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


local result = 'Level '..level..' '
    return tostring(result)
result = result..p.Icon({linkname, img=iconname, type='item', notext = true})..p.Icon({'Mastery', notext=true})
if showText then result = result..'[['..linkname..']] [[Mastery]]' end
result = '<span style="display:inline-block">'..result..'</span>'
return 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)
 
end
local fileName, link, altText = currencyDefn.img, currencyDefn.name, currencyDefn.abbr


function p._Currency(fileName, link, amt, maxAmt)
local function numColour(amount)
local amtText = formatnum(amt)
if tonumber(amount) < 0 then
if maxAmt ~= nil and maxAmt >= amt then
return mw.html.create('span')
amtText = amtText .. ' - ' .. formatnum(maxAmt)
:css('color', 'red')
:wikitext(formatnum(amount))
:done()
else
return formatnum(amount)
end
end
end
local html = mw.html.create('span')
:addClass('img-text')


local fileText = ''
-- 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
if fileName ~= nil then
fileText = '[[File:' .. fileName .. '|25px'
html:wikitext('[[File:'):wikitext(fileName):wikitext('|25px')
if link ~= nil then
if link ~= nil then
fileText = fileText .. '|link=' .. link
html:wikitext('|link='):wikitext(link)
end
end
fileText = fileText .. ']]&nbsp;'
html:wikitext('|alt=')
:wikitext(((altText == nil and '') or altText))
:wikitext(']]')
end
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


return '<span style="display:inline-block">' .. fileText .. amtText .. '</span>'
-- 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
end


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


function p.SC(amt, maxamt)
-- Function to retrieve the DLC id used for sorting columns that contain a DLC icon.
return p._Currency('Slayer Coins.svg', 'Currency#Slayer 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.RC(amt, maxamt)
function p.getExpansionIcon(id)
return p._Currency('Raid_Coins.svg', 'Currency#Raid 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
 
-- 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
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