Template:Icon: Difference between revisions

From Melvor Idle
(Special handling for Cooking upgrade icons)
(Use Module:Icons, ensuring consistent logic for icons in both Lua generated & user-written content)
Line 20: Line 20:
* <code>aurora</code> for aurora spells
* <code>aurora</code> for aurora spells
* <code>thieving</code> for Thieving NPCs
* <code>thieving</code> for Thieving NPCs
* <code>constellation</code> for Astrology constellations


Format is like so: {{T|Icon|type=combatArea|Castle of Kings|Knight Time}} becomes {{Icon|type=combatArea|Castle of Kings|Knight Time}}.
Format is like so: {{T|Icon|type=combatArea|Castle of Kings|Knight Time}} becomes {{Icon|type=combatArea|Castle of Kings|Knight Time}}.
Line 73: Line 74:
{{Icon|Wizard|type=thieving}}
{{Icon|Wizard|type=thieving}}
-->
-->
<includeonly><onlyinclude><!--
<includeonly><onlyinclude>{{#invoke:Icons|Icon|{{{1|}}}|{{{2|}}}|type={{{type|}}}|ext={{{ext|}}}|size={{#if:{{{size|}}}|{{{size}}}|{{#if:{{{menu|}}}|25|23}}}}|qty={{{qty|}}}|img={{{img|}}}|notext={{{notext|}}}|nolink={{{nolink|}}}|noicon={{{noicon|}}}|menu={{{menu|}}}}}</onlyinclude></includeonly>
Defining some variables to make things easier later
-->{{#vardefine:image|{{{1|}}}}}<!--
-->{{#vardefine:type|{{{type|}}}}}<!--
-->{{#vardefine:link|{{{1|}}}}}<!--
-->{{#vardefine:text|{{#if:{{{2|}}}|{{{2|}}}|{{#var:link}}}}}}<!--
-->{{#vardefine:ext|{{#if:{{{ext|}}}|{{{ext|}}}|svg}}}}<!--
-->{{#vardefine:size|{{#if:{{{size|}}}|{{{size}}}|{{#if:{{{menu|}}}|25|23}}}}}}<!--
    Allowing for manual exception overrides for weird cases:
        Melee uses the Combat icon
        Done to allow for easily fitting into combat triangle related tables
-->{{#ifeq:{{#var:link}}|Melee|{{#vardefine:image|Combat}}}}<!--
        Superheat goes to a generic Superheat page but pulls the icon for Superheat IV
-->{{#ifeq:{{#var:link}}|Superheat|{{#vardefine:image|Superheat IV}}{{#vardefine:type|spell}}}}<!--
        Item Alchemy goes to a generic Item Alchemy page but pulls the icon for Item Alchemy III
-->{{#ifeq:{{#var:link}}|Item Alchemy|{{#vardefine:image|Item Alchemy III}}{{#vardefine:type|spell}}}}<!--
        Special case to handle Basic/Standard/Generous Resupply shop items, which unusually are neither items nor upgrades
-->{{#switch:{{#var:link}}|Basic Resupply={{#vardefine:image|Lobster}}{{#vardefine:type|item}}|Standard Resupply={{#vardefine:image|Crab}}{{#vardefine:type|item}}|Generous Resupply={{#vardefine:image|Shark}}{{#vardefine:type|item}}}}<!--
        Skip disambiguation page for various ambiguous phrases, e.g. Chicken, Golbin
-->{{#switch:{{#var:link}}|Golbin|Chick|Chicken|Wizard={{#vardefine:link|{{#var:link}} ({{#var:type}})}}|Cyclops={{#vardefine:link|{{#var:link}} ({{#ifeq:{{#var:type}}|mark|item|{{#var:type}}}})}}}}<!--
        Handling for Spiders (since they come in two flavors)
-->{{#ifeq:{{#var:link}}|Spider (lv. 51)|{{#vardefine:image|Spider}}}}{{#ifeq:{{#var:link}}|Spider (lv. 52)|{{#vardefine:image|Spider2}}}}{{#ifeq:{{#var:link}}|Spider2|{{#vardefine:link|Spider (lv. 52)}}{{#ifeq:{{#var:image}}|{{#var:text}}|{{#vardefine:text|Spider (lv. 52)}}}}}}<!--
        Forcing the correct extension for the following:
            png: Rhaelyx items, Infernal Core, Miolite Caves monsters, Perilous Peaks monsters, Pyro pet, all 0.21+ items
            jpg: Lemon, Lemons, Lemonade
-->{{#switch:{{#var:image}}|Crown of Rhaelyx|Circlet of Rhaelyx|Jewel of Rhaelyx|Charge Stone of Rhaelyx|Mysterious Stone|Infernal Core|Wicked Greater Dragon|Hunting Greater Dragon|Chaotic Greater Dragon|Miolite Sprig|Miolite Trio|Miolite Warden|Miolite Monarch|Pyro|Adventure|Summoning Shard (Black)|Summoning Shard (Gold)|Summoning Shard (Silver)|Summoning Shard (Blue)|Summoning Shard (Green)|Summoning Shard (Red)|Cool Glasses|Infernal Core|Bag of Flour|Bread|Raw Beef|Beef|Raw Chicken|Apple|Plain Pizza Slice|Beef Pie|Meat Pizza Slice|Basic Soup|Strawberry Cupcake|Hearty Soup|Cherry Cupcake|Cream Corn Soup|Apple Pie|Chicken Soup|Strawberry Cake|Carrot Cake|Lemon Cake|Shrimp (Perfect)|Sardine (Perfect)|Herring (Perfect)|Seahorse (Perfect)|Trout (Perfect)|Salmon (Perfect)|Lobster (Perfect)|Swordfish (Perfect)|Anglerfish (Perfect)|Fanfish (Perfect)|Crab (Perfect)|Carp (Perfect)|Shark (Perfect)|Cave Fish (Perfect)|Manta Ray (Perfect)|Whale (Perfect)|Bread (Perfect)|Beef (Perfect)|Chicken (Perfect)|Plain Pizza Slice (Perfect)|Beef Pie (Perfect)|Meat Pizza Slice (Perfect)|Basic Soup (Perfect)|Strawberry Cupcake (Perfect)|Hearty Soup (Perfect)|Cherry Cupcake (Perfect)|Cream Corn Soup (Perfect)|Apple Pie (Perfect)|Chicken Soup (Perfect)|Strawberry Cake (Perfect)|Carrot Cake (Perfect)|Lemon Cake (Perfect)|Cherry Seeds|Cherry|Cheese|Cream|Sneak-Ers|Jeweled Necklace|Crate of Basic Supplies|Thiever's Cape|Marksman's Sigil|Crate of Food|Basic Bag|Cooking Apron|Shipwheel|Fishing Hook|Giant Club|Stack of Bones|Pile of Logs|Pile of Ores|Knight's Sigil|Knight's Cape|Whetstone|Wizard's Scroll|Wizard's Sigil|Prayer Scroll|Ring of Wealth|Chest of Gems|Antique Vase|Absorbing Shield|Chef's Spoon|Chef's Hat|Training Shield|Knight's Defender|Cave Giant Boots|Merchant's Permit|Bob's Gloves|Golbin Mask|Fine Coinpurse|Lumberjack's Top|Miner's Helmet|Sailor's Top|Jester's Hat|Jadestone|Gold Crested Shield|Book of Scholars|Amulet of Incantation|Thief's Moneysack|Seed Pouch|Runecrafting Pouch|Alchemist's Bag|Apple Tree Seeds={{#vardefine:ext|png}}|Chicken={{#ifeq:{{#var:type}}|item|{{#vardefine:ext|png}}}}|Lemon|Lemons|Lemonade={{#vardefine:ext|jpg}}}}<!--
        Additional extension overrides for Summoning marks
-->{{#ifeq:{{#var:type}}|mark|{{#vardefine:ext|png}}}}<!--
        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}}}}}}<!--
        Handling for Cooking Upgrade icons
-->{{#switch:{{#var:image}}|Cooking Upgrade 1|Cooking Upgrade 2={{#vardefine:image|Cooking}}{{#vardefine:type|skill}}}}<!--
Handling for 'menu' option
-->{{#if:{{{menu|}}}|{{{!}} class="articletable" style="display:inline; vertical-align:middle;"
{{!}}-
{{!}}| }}<!--
--><span style="display:inline-block">{{#if:{{{qty|}}}|{{formatnum:{{{qty|}}}}}&nbsp;|}}[[File:{{#var:image}}{{#if:{{#var:type}}|_({{#var:type}})|}}.{{#var:ext}}|{{#var:size}}x{{#var:size}}px|link={{#var:link}}]]{{#if:{{{notext|}}}||&nbsp;[[{{#var:link}}|{{#var:text}}]]}}</span><!--
-->{{#if:{{{menu|}}}|<br/>
{{!}}}|}}</onlyinclude></includonly>

Revision as of 22:51, 13 November 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.

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
  • constellation for Astrology constellations

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

You can also just do {{Icon|Combat}} 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}} Melee
{{Icon|Item Alchemy}} Item Alchemy
{{Icon|Superheat}} Superheat
{{Icon|Basic Resupply}} Basic Resupply
{{Icon|Standard Resupply}} Standard Resupply
{{Icon|Generous Resupply}} Generous Resupply
{{Icon|Golbin|type=monster}} Golbin
{{Icon|Spider (lv. 51)|type=monster}} Spider (lv. 51)
{{Icon|Spider2|type=monster}} File:Spider2 (monster).png Brown Spider
{{Icon|Alt. Magic|type=skill}} Alt. Magic

Other options:

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

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

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

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