Module:Icons

Template for displaying small icons.

Usage

{{icon|name of icon}}

To update the available icons, the Icon module requires a new parameter in the iconTip (default tooltip) and gameIcon (icon filename) lists. Change icons at Module:Icons/data. Change flags at Module:Flag.

Parameters

<unnamed 1>

Which icon should be displayed. Multiple icons can be listed by separating them with a comma. ({{Icon|FO1,FO2,FO3}})

(default: "x14px")

<unnamed 2>

Specifies the size of the icon. Can either be set to one of the presets below or directly given as a px value (same syntax as for setting the image size of a normal file link).

The presets are:

• small: Icons will be displayed at 10px height.
• medium/normal: Icons will be displayed at 14px height.
• big: Icons will be displayed at 20px height.

link

Page the icon should link to (without enclosing "[[]]"). If tooltip is not specified, this is also used as the tooltip text.

tooltip

Tooltip text is displayed when hovering over the icon. Overrides the icon's default text.

Available icons

prefix	Icon	prefix	Icon	prefix	Icon
ability		ac		acid
action		agi		alcohol
amber		ammo		ammo2
android		ap		apple
ar		armorwb		atom
attack		axed		big gun
bigger gun		blade		bleed
blunt		bonus effect		boss
brain		bronze		bugged unav
bullion		camp		caps
caravan		cards		chance
check		check1		checkbrown
chems		chemst		chr
companion		confidence		cookst
craft		credit		crit
crit effect		cross		crosshair
cryo		cut		d20
dailyops		damage		dap
dead		defense		detect
detection		dial		dialogue
disease		dislike		distance
doctor		dps		dr
drink		dt		dur
effect		electrical		emp
end		energy		enslave
essential		event		eventpublic
experience		explmill		explosion
eye		facebook		fb
fbg		fbgagenda		fbgaggressive
fbgagility		fbgapparel		fbgarmor
fbgasset		fbgcharisma		fbgcompanion
fbgcritter		fbgdangerous		fbgdeadly
fbgdieablhits		fbgendurance		fbgfreedom
fbghit		fbghuman		fbgintelligence
fbgloot		fbgluck		fbgmonster
fbgnc		fbgperception		fbgquest
fbgradiation		fbgranged		fbgretreat
fbgrobot		fbgsecurity		fbgsettlement
fbgstrength		fbgsupermutant		fbgvault109
fbgvault84		fbgwasteland		fbgweapon
fbgww		female		film
fire		firerate		fist
fnv		fnvcs		fnvdm
fnvgra		fnvhh		fnvlr
fnvowb		fnvww		fo
fo1		fo1st		fo2
fo3		fo3bs		fo3mz
fo3oa		fo3pl		fo3tp
fo4		fo4aut		fo4cc
fo4chain01		fo4chain02		fo4chain03
fo4cw		fo4fh		fo4gencard
fo4holo		fo4key01		fo4key02
fo4key03		fo4note		fo4nw
fo4vaultid		fo4vr		fo4vw
fo4ww		fo76		fo76fw
fo76ib		fo76ll		fo76lr
fo76nm		fo76nw		fo76ow
fo76sd		fo76sr		fo76tp
fo76ts		fo76wa		fo76wl
fobos		fobos2		food
foodpr		fool		fos
foso		fot		fot2
fow		foww		fox
fpb		free		frost
fww		fwwrpg		game
gamerscore		gas		gold
gold bullion		green		grenade
group		gun		hate
healing		healing rate		health
heart		hp		image
info		instagram		int
ios		jes		jury
laser		lck		legendary
legendperk		level		lh
like		limited		limitedtime
linkedin		loc		love
lunchbox		mac		macclassic
mag		male		melee
mentioned		merchant		mine
mod		mutate		mutation
myspace		neutral		neutralface
new		no		note
notrade		nukamix		nw
optional		pa		pail
parmorst		pbgame		pc
per		percent		pistol
plasma		platinum		poison
poison2		possum		possum dark
present		ps3		ps4
publicworkshop		pv13		pve
pvp		quest		question
radiation		random		range
rarity		ratio		red
repair		repeat		required
rifle		robotwb		score
scout		scrip		season
seasonal		semi		semi-required
sequence		shieldbronze		shieldgold
shieldsilver		shotgun		sic
silver		smg		soda
sound		spawn		spooky
spread		star		stimpak
str		survival		switch
tadpole		tadpole dark		tar
tea		temp		text
torn		tumblr		twitch
twitter		unarmed		unused
upcoming		v76		vaultraid
vaulttec		vb		vt
weapwb		weight		wiki
wild wasteland		windows		workshop
ww		xbox360		xboxone
xp		yes

In addition, all abbreviations supported by {{Abb}} can be used to produce an icon for the corresponding game.

---

local p = {}
local util = require( 'Module:Util' )
--[[
	Icon data is now stored on the sub page /data to seperate functional code
	for the dataset users will often need to update. This reduces the risk of
	breaking the code by entering data in the wrong place and makes it easier to
	manage the code itself by not having to pass through the large dataset at 
	the top.
]]

require( 'Module:Icons/data' ) 

local iconSize = {
    --[[
        All sizes are controlled on the height to ensure a string of icons maintain 
        a consistent line height
    ]]
    ["small"]           = "x10px",
    ["medium"]          = "x14px",
    ["normal"]          = "x14px",
    ["big"]             = "x20px",
}

--[[ 28/Oct/2021 Added class control table to array as to handle light/dark 
	themes. This was originally put into the frontend template, when class
	handling should be back end. Adding the ['class'] = 'light' or 
	['class'] = 'dark' parameter to a icon's dataset on /data will enable it to
	access a class if needed.
	]]

--[[ 08/Nov/2021 Remove the class definition as to be able to just pass straight through
local class = {
	['light'] = 'lighticon',
	['dark'] = 'darkicon',
	['general'] = 'generalicon'
}
]]

function _generate(iconList, iconSetting, iconLinks, tipOverride, iconClass, iconSize)
	local parserError = ''
    if util.exists(iconSetting)  then 
    	iconSetting = util.trim(iconSetting)
        if util.exists(iconSize[iconSetting]) then
            iconSetting = iconSize[iconSetting]
        end
    else
        iconSetting = iconSize["medium"]
    end
    
    if util.exists(iconLinks) then
        iconLinks = mw.text.split(iconLinks, ",")
    end
        
    if util.exists(tipOverride) then
        tipOverride = mw.text.split(tipOverride, ",")
    end
    
    if util.exists(iconClass)then
    	iconClass = "|class=" .. tostring(iconClass);
    else
    	iconClass = ""
    end

    local result = ""

    for k, v in ipairs(iconList) do
        newIcon = iconData[util.trim(v)]
        if util.exists(newIcon) then
            currentIcon = newIcon.icon
            if util.exists(tipOverride, k) then
                currentTip = tipOverride[k]
            else
                if util.exists(iconLinks, k) then
                    currentTip = iconLinks[k]
                else
                    currentTip = newIcon.tip
                end
            end
        else
            currentIcon = "Icon question.png"
            currentTip = "Unrecognized icon name"
            result = result .. "[[Category:Modules with invalid parameters]]"
        end
        
        --Create wikitext icon
		dataLine = '[[File:' .. currentIcon .. '|' .. iconSetting
        if util.exists(iconLinks, k) then
            dataLine = dataLine .. '|link=' .. iconLinks[k]
        else
            dataLine = dataLine .. '|link='
        end
        if currentTip ~= nil then
            dataLine = dataLine .. '|' .. currentTip
        end

        dataLine = dataLine .. iconClass .. ']]'

		createTip = mw.html.create('span')
        	createTip:addClass( 'va-icon' )
        	:attr('title', currentTip)
        	:wikitext(dataLine)
        result = result .. tostring(createTip)
        
        if k < table.getn(iconList) then
        	result = result .. " "
        end
    end
    
    return result .. parserError
end

function p.Icons(frame) 
	--[[All icons are now lower case to reduce script errors from 
	incorrectly entering the icon code in a different case to the list]]
    local iconList = mw.text.split(string.lower(frame.args[1]), ",")
    local iconSetting = frame.args[2]
    local iconLinks = frame.args[3]
    local tipOverride = frame.args[4]
    local iconClass = frame.args[5]	
	local iconSize = {
    	--[[
    	    All sizes are controlled on the height to ensure a string of icons maintain 
	        a consistent line height
    	]]
    	["small"]           = "x10px",
    	["medium"]          = "x14px",
    	["normal"]          = "x14px",
    	["big"]             = "x20px"
	}
    return _generate(iconList, iconSetting, iconLinks, tipOverride, iconClass, iconSize)    
end

function p.platforms(frame)
	--[[All icons are now lower case to reduce script errors from 
	incorrectly entering the icon code in a different case to the list]]
    local icons = mw.text.split(string.lower(frame.args[1]), ",")
    local result = ""
    
    for k, v in ipairs(icons) do
        currentIcon = iconData[util.trim(v)]
        
        if util.exists(currentIcon, 'platform') == true then
        	
            createSM = mw.html.create('span')
            	createSM:css('display', 'none')
            	:wikitext('[[Has platform::' .. currentIcon.tip .. ']]')
            	:allDone()
            createPlatform = mw.html.create('span')
            	createPlatform:addClass('va-icon')
            		:attr('title', currentIcon.tip)
            		:wikitext('[[File:' 
            			.. currentIcon.icon 
            			.. '|alt='
            			.. currentIcon.alt
            			.. '|x14px|link=]]')
            		:allDone()
            	--[[ Uncommenting tostring(createSM) below will enable 
            	Semantic Mediawiki data tracking]]
            	result = result .. tostring(createSM) 
            			.. tostring(createPlatform)
            if k < table.getn(icons) then
                result = result .. " "
            end
        end
    end
    if result == '' then
        result = '<sup>[Platforms needed]</sup>[[Category:Platforms needed]]'
    end
    
    return result
end    

function p.documentation()
    keys = {}
    for k in pairs(iconData) do
        table.insert(keys, k)
    end
 
    table.sort(keys)
    result = '{| class="va-table va-table-full"\n|-\n !prefix!!Icon!!prefix!!Icon!!prefix!!Icon\n|-\n'
    set = 1
    for k,v in ipairs(keys) do
		i = iconData[v]
        result = result .. "||'''" .. v .. "'''"
        if util.exists(i) == true and i.class ~= nil then
        	newFile = mw.html.create(span)
        		--:addClass(class[i.class])
        		:wikitext('[[File:' .. iconData[v].icon .. '|25px]]')
        else
        	newFile = mw.html.create(span)
        		:wikitext('[[File:' .. iconData[v].icon .. '|25px]]')
        end
        result = result .. '||' .. tostring(newFile)
 
        if set == 3 then
            result = result .. '\n|-\n'
        end
 
        if set < 3 then
            set = set + 1
        else
            set = 1
        end
    end
 
    result = result .. '\n|}'
 
    return result
end

function p.Test(frame) 
	--Please empty when done debugging so other users know it is free to use

end

return p