Template:Exclusive icons

From Terraria Wiki
(Redirected from Template:Eicons)
Jump to navigation Jump to search
This template uses Lua.
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.
Template-info.svg Documentation The documentation below is transcluded from Template:Exclusive icons/doc. (edit | history)

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 }}

ParameterDescriptionTypeStatus
Entity name1
Name of the entity (item, NPC, event, biome, patch number, etc.) for which the icons are to be displayed.
Line
suggested
Smaller iconssmall
Reduces the size of the icons. Useful when space is an issue, e.g. in infoboxes.
Auto value:
True (1/y/yes)
Boolean
optional
Invert exclusivityinvert
Inverts the exclusivity, i.e. displays the opposite eicons. Note that this disables the Japanese Console version sensor.
Auto value:
True (1/y/yes)
Boolean
optional
Subtract exclusivitynot
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
Desktop overridedesktop
dsk
Manually override the Desktop version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional
Console overrideconsole
cns
Manually override the Console version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional
Old-gen overrideold-gen
oldgen
old
Manually override the Old-gen console version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional
Mobile overridemobile
mbl
Manually override the Mobile version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional
3DS override3DS
3ds
Manually override the 3DS version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional
Japan overridejapan
jas
Manually override the Japanese Console version exclusivity. Note that this evaluated after $invert and $not.
Boolean
optional

This template prefers inline formatting of parameters.

Examples

Code Result
{{eicons| 1.4.0.1 }} (Desktop, Console and Mobile versions) (DCM)
{{eicons| 1.2.4.1 | not = 1.3.0.1 }} (Old-gen console version) (O)
{{eicons| Suspicious Looking Egg }} (3DS version) (3)
{{eicons| Suspicious Looking Egg | invert = 1 }} (Desktop, Console, Old-gen console and Mobile versions) (DCOM)
{{eicons| Suspicious Looking Egg | invert = 1 | small = 1 }} (Desktop, Console, Old-gen console and Mobile versions) (DCOM, small)
{{eicons| Soul of Blight }} (Old-gen console and 3DS versions) (O3)
{{eicons| Suspicious Looking Egg | small = 1 }} (3DS version) (3, small)
{{eicons| Easter }} (3DS version) (3)
{{eicons| Underground Desert }} (Desktop, Console and Mobile versions) (DCM)
{{eicons| Flinx Staff }} (Desktop, Console and Mobile versions) (DCM)
{{eicons| Traveling Merchant | not = Moon Lord }} (Old-gen console version) (O)
{{eicons| Traveling Merchant | invert = 1 | not = Moon Lord }} (3DS version) (3; not DCM3 because invert is evaluated before not)
{{eicons| Underground Desert | invert = 1 | not = Suspicious Looking Egg }} (Old-gen console version) (O)
{{#iferror:{{eicons| Work Bench }}}} (nothing, since Work Bench is on all versions, so it will output an error which is caught by {{#iferror:}})
{{eicons| Work Bench | mobile = 1 }} (Mobile version) (M)
{{eicons| Work Bench | old-gen = 1 | 3ds = 1 }} (Old-gen console and 3DS versions) (O3)
{{eicons| Martian Work Bench | desktop = 0 | console = 0 }} (Mobile version) (M)
{{eicons| desktop = 1 | console = 1 | old-gen = 1 | mobile = 1 }} (Desktop, Console, Old-gen console and Mobile versions) (DCOM)
{{eicons| japan = 1 }} (J)
{{eicons| japan = 1 | small = y}} (J)
{{item|Stone Block}} {{eicons| desktop = 1 | console = 1 | old-gen = 1 | mobile = 1 }} Stone BlockStone Block (Desktop, Console, Old-gen console and Mobile versions)

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.

NameAliasInitial ValueValue Mapping[1]Note
small(empty)yesy
ony
n(empty)
no(empty)
off(empty)
  1. Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.

Examples

Result Code Note
(Old-gen console and 3DS versions) {{eicons|Hallowed Key Mold}} Default
small = ; small = {{options/get|eicons|small}}; Get current setting
(Old-gen console and 3DS versions) {{options/set|eicons|small=y}}
{{eicons|Hallowed Key Mold}}
Turn on small icons
small = y; small = {{options/get|eicons|small}}; Get current setting
(Old-gen console and 3DS versions) {{options/reset|eicons}}
{{eicons|Hallowed Key Mold}}
Reset all options