Template:Icon: Difference between revisions

From Melvor Idle
(Expand & format documentation)
(Special handling for Cooking upgrade icons)
Line 103: Line 103:
         Allowing for Alt. Magic to use the Magic image
         Allowing for Alt. Magic to use the Magic image
-->{{#ifeq:{{#var:type}}|skill|{{#switch:{{#var:link}}|Alt. Magic|Alt Magic|Alternative Magic={{#vardefine:image|Magic}}{{#vardefine:link|Alternative Magic}}}}}}<!--
-->{{#ifeq:{{#var:type}}|skill|{{#switch:{{#var:link}}|Alt. Magic|Alt Magic|Alternative Magic={{#vardefine:image|Magic}}{{#vardefine:link|Alternative Magic}}}}}}<!--
        Handling for Cooking Upgrade icons
-->{{#switch:{{#var:image}}|Cooking Upgrade 1|Cooking Upgrade 2={{#vardefine:image|Cooking}}{{#vardefine:type|skill}}}}<!--
Handling for 'menu' option
Handling for 'menu' option
-->{{#if:{{{menu|}}}|{{{!}} class="articletable" style="display:inline; vertical-align:middle;"
-->{{#if:{{{menu|}}}|{{{!}} class="articletable" style="display:inline; vertical-align:middle;"

Revision as of 11:18, 10 October 2021

A generic version of the template used in things like Template:ItemIcon or Template:UpgradeIcon.

You probably want to use one of the following instead for most things:

For example: {{ItemIcon|Raw Trout}} becomes Raw Trout (item).svg Raw Trout.

Some icon categories/types do not have these shorthand templates, so instead the type parameter should be used: {{Icon|<IconName>|type=<IconType>}}. The types this applies to are as follows:

  • mark for Summoning marks
  • spell for standard and ancient magick spells
  • curse for curse spells
  • aurora for aurora spells
  • thieving for Thieving NPCs

Format is like so: {{Icon|Castle of Kings|Knight Time|type=combatArea}} becomes Castle of Kings (combatArea).svg Knight Time.

You can also just do {{Icon|Combat}} Combat.svg Combat if you need an icon for an image that doesn't belong to a given category.

Some special overrides exist:

Input Output
{{Icon|Melee}} Combat.svg Melee
{{Icon|Item Alchemy}} Item Alchemy III (spell).svg Item Alchemy
{{Icon|Superheat}} Superheat IV (spell).svg Superheat
{{Icon|Basic Resupply}} Lobster (item).svg Basic Resupply
{{Icon|Standard Resupply}} Crab (item).svg Standard Resupply
{{Icon|Generous Resupply}} Shark (item).svg Generous Resupply
{{Icon|Golbin|type=monster}} Golbin (monster).svg Golbin
{{Icon|Spider (lv. 51)|type=monster}} Spider (monster).svg Spider (lv. 51)
{{Icon|Spider2|type=monster}} File:Spider2 (monster).svg Spider (lv. 52)
{{Icon|Alt. Magic|type=skill}} Magic (skill).svg Alt. Magic

Other options:

The 'notext' option sends only the image (with link), so {{Icon|Mastery|notext=true}} becomes Mastery.svg

The 'menu' option formats the icon in a handy table (useful for menuboxes) so {{Icon|Combat|menu=true}} becomes

Combat.svg Combat

The 'qty' option allows you to specify a number of items to go between the icon and the text, so {{Icon|Elder Dragonhide|qty=5000|type=item}} becomes 5,000 Elder Dragonhide (item).svg Elder Dragonhide

The 'size' option allows you to specify larger icons, so {{Icon|Combat|notext=true|size=50}} becomes Combat.svg