Module:Icons/doc

	This page contains usage information for Module:Icons.

Change icons here Module:Icons/data.

A library of functions for displaying icons on pages or within other templates. For best performance, a chain of icons (sit in a row with nothing between) should be done with a single call.

Functions

This module relies on the exists() and trim() contained within Module:Util. All function calls from this module are prefixed with util e.g. util.exists().

_generate()

This function is internal only and the main workhorse for p.Icons() and p.innerIcon(). This function builds the function list. The first task is determining the size of the icons.

    if util.exists(iconSetting)  then 
    	iconSetting = util.trim(iconSetting)
        if util.exists(iconSize[iconSetting]) then
            iconSetting = iconSize[iconSetting]
        end
    else
        iconSetting = iconSize["medium"]
    end
    -- This is for calls from other Lua modules as the above will result in nil
    if util.exists(iconSetting) == false then
    	if util.exists(iconSize) then
			iconSetting = iconSize
		else
			iconSetting = iconSize["medium"]
		end
    end

In wikitext mark up the rough equivalent would be:

{{#ifeq:{{{iconSetting}}}|medium|{{#switch:{{{iconSetting}}}|a = x14px |b = 16px| c= 20px|...|#default = {{{iconSize|x14px}}}}}}}

The next step is to break the comma separated lists into a table:

    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

This would be the equivalent of using multiple {{#explode:}} functions and variables to store each item as its own.

Once the data has been pre-processed a loop is used to run through each item in the list to generate the icon collection:

    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

Line 2 checks the data list at Module:Icons/data for the data relating to the icon short code and returns a result or nil (does not exist) Depending on if a result was found the code continues, if there is no match a dummy icon is supplied at lines 14/15 and a maintenance category added at line 16.

If a match is found, the next task is to check if the tooltip is being overwritten, if it isn't being overwrite, it will then check if an page alternative link has been supplied, otherwise fall back to the default tooltip.

The wikitext equivalent would be

{{{tipOverride|{{{iconLinks|default}}}}}}

Now the correct icon, tooltip and link have been obtained, lines 21-31 build the image file in the format [[File:<icon>|<size>|link=<link>|<tooltip>|class=<class>]].

Lines 33-37 create the <span /> which contains the icon and inserts the icon inside. When rendered this will appear as <span class="va-icon" title="<tooltip>">icon</span>.

Finally lines 39-41 check if the item being created is the last in the list to be created. If not it will add a space at the end of the string so there is space between the icons on the page once completed.

Invocation parameters

The invocation parameters are passed through from p.Icons(frame) or p.innerIcon(iconList, iconSetting, iconLinks, tipOverride, iconClass, iconSize). The variables align between these three functions and the below should be taken as an explanation for all three.

Label	Parameter	Variable	Description	Required	Example
Icons	1	iconList	A string list of icon short code(s) passed through to the module. For multiple codes being passed these should be split by a comma (,).		fo76,ww
Icon Size	2	iconSetting	The image size to be passed to all icons in the list. A custom size can be set (e.g. x26px) or one of the standard sizes can be applied: small = x10px medium = x14px normal = x14px big = x20px To ensure all icons are consistent in size, it is recommended to control on the height (e.g. x14px) rather than the width (e.g. 14px)	- Defaults are built in
Link	3	iconLinks	The page(s) the icon(s) links to. For multiple pages, article names are split with a comma (,)		Fallout 76,Wild Wasteland
Tooltip	4	tipOverride	The tooltip(s) shown when hovering over the icon(s), for multiple icons, the tooltips can be split with a comma (')	- Defaults are built in	Fire, EMP
CSS Class	4	iconClass	CSS classes to be applied to the icons. If this is set it will apply to all icons in the group. Classes are written without the class= component.		va-icon va-icon-blue

p.Icons() and p.innerIcon()

These two functions are pass through functions to _generate(). Before passing through the list of icons supplied is split.

The differences between the functions is where they should be used and that p.innerIcon() doesn't pass through a table of icon sizes, just a predetermined size and can only be called from other lua modules. p.Icons() is for all other namespaces and cannot be called from another module.

Invocation parameters

Due to the close nature of these two functions and _generate() the invocation parameters are the same as listed above.

p.platforms()

p.platforms() uses the same data set as the other functions, but only returns results for icons that have been marked as being a platform in the data set. In addition to this, it also uses Semantic Mediawiki so the data returned can be queried in Special:Ask.

Once the function has confirmed the icon in the list is a valid platform, it will create a hidden <span /> holding the semantic tag advising of the platform assigned from the default tooltip [[Has platform::<platform>]]. The code then largely follows that of _generate() to create the icon, with a blank link attribute. The two spans are then joined together before checking for the next platform.

If no platforms are found the code will return <sup>[Platforms needed]</sup>[[Category:Platforms needed]].

Invocation parameters

The only parameter taken by this function is the iconList parameter, holding the string of short codes.

p.documentation()

p.documentation() is self generating documentation to display the icon produced by each short code. It first takes all the datasets available and sorts them into alphabetical order and creates a table header allowing for 3 icons in a row. For each short code it will put the short code in the first, third or fifth column and the icon in the second, fourth or sixth column based on where in the sorted dataset it resides.

Due to the ever expanding icon list, this function does run the risk of becoming oversized with time. If the character size is exceeded it may need splitting into two functions.

Invocation parameters

As a self contained function, there are not parameters that can be passed through.

Available icons

prefix	Icon	prefix	Icon	prefix	Icon
FNV		FNVCS		FNVDM
FNVGRA		FNVHH		FNVLR
FNVOWB		FO		FO1
FO1ST		FO2		FO3
FO3BS		FO3MZ		FO3OA
FO3PL		FO3TP		FO4
FO4AUT		FO4CC		FO4CW
FO4FH		FO4NW		FO4VR
FO4VW		FO4WW		FO76
FO76FW		FO76IB		FO76LL
FO76LR		FO76MI		FO76NM
FO76NW		FO76NWT		FO76OW
FO76RD		FO76SD		FO76SR
FO76TM		FO76TP		FO76WA
FO76WL		FOBOS		FOBOS2
FOS		FOSO		FOT
FOT2		FOW		FOWW
FOX		FPB		FWW
FWWRPG		ability		ac
acid		action		agi
agi dark		alcohol		ammo
ammo2		android		aotl
ap		apple		ar
armorwb		atom		attack
axed		blade		bleed
blunt		bonezone		bonus effect
boss		brain		bronze
bullion		camp		caps
caravan		cards		chance
chance fo76		check		check1
checkbrown		chems		chemst
chr		chr dark		colmod
companion		confidence		cookst
craft		credit		crit
crit effect		cross		crosshair
cryo		csep		cut
d20		dailyops		damage
dap		dead		default
defense		detect		detection
dial		dialogue		disease
dislike		dislike2		distance
diz		doctor		dos
dps		dr		drink
dt		dur		effect
electrical		emp		end
end dark		energy		enslave
essential		event		eventpublic
expedition		expeditions		experience
explmill		explosion		expo
expos		eye		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		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		fo76acap		fo76acbp
fo76fw		fo76ib		fo76ll
fo76lr		fo76mi		fo76nm
fo76nw		fo76nwt		fo76obm
fo76ow		fo76rd		fo76sd
fo76sr		fo76tm		fo76tp
fo76wa		fo76wl		fobos
fobos2		folon		food
foodpr		fos		foso
fot		fot2		fow
foww		fox		fpb
free		frost		fww
fwwrpg		game		gamerscore
gas		gold		grenade
group		gun		hate
hate2		healing		healing rate
health		heart		hp
image		info		int
int dark		ios		jes
jury		laser		lck
lck dark		legacy		legendary
legendperk		level		lgbtq
like		like2		limited
limitedtime		loc		location
love		love2		lunchbox
mac		macclassic		mag
melee		mentioned		merchant
mine		mod		mpbs
mpcmp		mpdf		mpdm
mpfnv		mpfo3		mphh
mpmt		mpmz		mpoa
mpowb		mppl		mpreq
mptp		mutation		mutation dark
neutral		neutralface		neutralface2
new		no		note
notrade		nukamix		nw
optional		pail		parmorst
pbgame		pc		per
per dark		percent		physical
pistol		plan		plasma
platinum		plus		poison
poison2		possum		possum dark
present		ps2		ps3
ps4		ps5		publicworkshop
pve		pvp		quest
question		radiation		random
range		rarity		ratio
removed		repair		repeat
required		rifle		robotwb
rwot		score		scout
scrip		season		seasonal
semi		semi-required		sequence
shieldbronze		shieldgold		shieldsilver
shotgun		sic		silver
smg		sound		spawn
spooky		spread		stamp
star		stimpak		str
str dark		stucomm		studata
stuedit		stuoutside		survival
tadpole		tadpole dark		tea
temp		test		text
ticket		tickets		ttw
unarmed		unused		upcoming
v76		vaultraid		vaulttec
vb		vt		weapwb
weight		wiki		wild wasteland
windows		ww		xbox
xbox360		xboxone		xboxseries
xp		xpd		yes

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