Exclusive icons

This template uses Module:Exclusive, a script written in the Lua programming language. To learn more about Lua, see Terraria Wiki:Lua.

This template is i18n-ready, which means it is easy to localize for different languages. Please see I18n & l10n for templates to learn more.

Documentation The documentation below is transcluded from Template:Exclusive icons/doc. (edit | history)

[purge]

Displays the icons indicating the platforms for which an entity is available, "eicons" (from "exclusive icons") in short. For displaying a link with eicons, use {{exclusive icon link}}.

You can use {{eicons/options}} to change the default values of some parameters. See the relevant section below for details.

Usage

{{ eicons | <entity name> | small = 0/1 | invert = 0/1 | not = <entity name> | <platform parameters> = 0/1 }}

Parameter		Description	Type	Status
Entity name	`1`	Name of the entity (item, NPC, event, biome, patch number, etc.) for which the icons are to be displayed.	Line	suggested
Smaller icons	`small`	This is default. If set to false in options/set, this can be used to override, reducing the size of the icons. Useful when space is an issue, e.g. in infoboxes. Auto value: True (`1`/`y`/`yes`)	Boolean	optional
Invert exclusivity	`invert`	Inverts the exclusivity, i.e. displays the opposite eicons. Note that this disables the Japanese Console version sensor. Auto value: False (`0`)	Boolean	optional
Subtract exclusivity	`not` `pagenot`	Name of an entity whose eicons are to be subtracted from the main eicons. Note that this is evaluated after `$invert`, i.e. the eicons of the main entity are inverted first, and then the eicons of the entity from this parameter are subtracted from that.	Line	optional
PC override	`PC` `dsk` `desktop`	Manually override the PC version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Console override	`console` `cns`	Manually override the Console version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Old-gen override	`old-gen` `oldgen` `old`	Manually override the Old-gen console version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Japan override	`japan` `jas` `jp`	Manually override the Japanese Console version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Mobile override	`mobile` `mbl`	Manually override the Mobile version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Windows Phone override	`windowsphone` `wp`	Manually override the Windows Phone version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
New Chinese override	`newchinese` `nc`	Manually override the New Chinese version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
Old Chinese override	`oldchinese` `oc`	Manually override the Old Chinese version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
3DS override	`3DS` `3ds`	Manually override the 3DS version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
tModLoader override	`tmodloader` `tml`	Manually override the tModLoader version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional
tModLoader 1.3-Legacy override	`tmodloaderlegacy` `tml1.3`	Manually override the tModLoader 1.3-Legacy version exclusivity. Note that this evaluated after `$invert` and `$not`.	Boolean	optional

This template prefers inline formatting of parameters.

Test of raw TemplateData output:

Displays icons indicating the platforms on which an entity is available.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Entity name	`1`	Name of the entity (item, NPC, event, biome, patch number, etc.) for which the icons are to be displayed. Auto value	Line	suggested
Smaller icons	`small`	This is default. If set to false in options/set, this can be used to override, reducing the size of the icons. Useful when space is an issue, e.g. in infoboxes. Auto value `1`	Boolean	optional
Invert exclusivity	`invert`	Inverts the exclusivity, i.e. displays the opposite eicons. Note that this disables the Japanese Console version sensor. Auto value `0`	Boolean	optional
Subtract exclusivity	`not` `pagenot`	Name of an entity whose eicons are to be subtracted from the main eicons. Note that this is evaluated after "invert", i.e. the eicons of the main entity are inverted first, and then the eicons of the entity from this parameter are subtracted from that. Auto value	Line	optional
PC override	`PC` `dsk` `desktop`	Manually override the PC version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Console override	`console` `cns`	Manually override the Console version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Old-gen override	`old-gen` `oldgen` `old`	Manually override the Old-gen console version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Japan override	`japan` `jas` `jp`	Manually override the Japanese Console version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Mobile override	`mobile` `mbl`	Manually override the Mobile version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Windows Phone override	`windowsphone` `wp`	Manually override the Windows Phone version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
New Chinese override	`newchinese` `nc`	Manually override the New Chinese version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
Old Chinese override	`oldchinese` `oc`	Manually override the Old Chinese version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
3DS override	`3DS` `3ds`	Manually override the 3DS version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
tModLoader override	`tmodloader` `tml`	Manually override the tModLoader version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional
tModLoader 1.3-Legacy override	`tmodloaderlegacy` `tml1.3`	Manually override the tModLoader 1.3-Legacy version exclusivity. Note that this evaluated after "invert" and "not".	Boolean	optional

Examples

`{{eicons\| 1.4.0.1 }}`	→ (DCMS)
`{{eicons\| 1.3.0.1 \| not = 1.4.0.1 }}`	→ (T)
`{{eicons\| Suspicious Looking Egg }}`	→ (3)
`{{eicons\| Suspicious Looking Egg \| invert = 1 }}`	→ (DCOMST)
`{{eicons\| Suspicious Looking Egg \| invert = 1 \| small = 0 }}`	→ (DCOMST), not small
`{{eicons\| Soul of Blight }}`	→ (O3)
`{{eicons\| Suspicious Looking Egg \| small = 0 }}`	→ (3), not small
`{{eicons\| Easter }}`	→ (3)
`{{eicons\| Underground Desert }}`	→ (DCMST)
`{{eicons\| Flinx Staff }}`	→ (D)
`{{eicons\| Gold Butterfly }}`	→ (DCMST)
`{{eicons\| Gold Butterfly \| not = Flinx Staff }}`	→ (CMST)
`{{eicons\| Gold Butterfly \| invert = 1 \| not = Crystal Work Bench }}`	→ (O3), not DO3 because `invert` is evaluated before `not`
`{{eicons\| Gold Butterfly \| invert = 1 \| not = Suspicious Looking Egg }}`	→ (O)
`{{eicons\| 1.3.0.1 \| not = 1.4.0.1 }}`	→ (T)
`{{#iferror:{{eicons\| Work Bench }}}}`	→ (nothing, since Work Bench is on all versions, so it will output an error and is catched by {{#iferror:}})
`{{eicons\| Work Bench \| mobile = 1 }}`	→ !!Error: Available on all platforms! (M)
`{{eicons\| Work Bench \| old-gen = 1 \| 3ds = 1 }}`	→ !!Error: Available on all platforms! (O3)
`{{eicons\| Martian Work Bench \| PC = 0 \| console = 0 }}`	→ (MST)
`{{eicons\| PC = 1 \| console = 1 \| old-gen = 1 \| mobile = 1 }}`	→ (DCOM)
`{{eicons\| japan = 1 }}`	→ (J)
`{{eicons\| japan = 1 \| small = n}}`	→ (J)
`{{item\|Stone Block}} {{eicons\| PC = 1 \| console = 1 \| old-gen = 1 \| mobile = 1 }}`	→ Stone Block

Change default options

This template supports options through {{options}} template. All valid options are listed below, see {{options}} for usage and other infomation.

See Template:eicons/initOptions for the initial options setting of this template.

Name	Alias	Initial Value	Value Mapping^[1]	Note
`small`		`(empty)`	`y` → `(empty)` `yes` → `(empty)` `on` → `(empty)` `no` → `n` `off` → `n`

↑ Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.

Examples

Code	Result	Note
`{{eicons\|Hallowed Key Mold}}`		Default
`small = {{options/get\|eicons\|small}};`	small = ;	Get current setting
`{{options/set\|eicons\|small=n}} {{eicons\|Hallowed Key Mold}}`		Turn off small icons
`small = {{options/get\|eicons\|small}};`	small = n;	Get current setting
`{{options/reset\|eicons}} {{eicons\|Hallowed Key Mold}}`		Reset all options

[1] Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.

[1]