Open main menu

Project: Gorgon Wiki β

Changes

Template:Item icon/doc

1,095 bytes added, 13:34, 6 December 2023
m
Slightly improved documentation.
__NOTOC__
==Description==
This template accepts an item name as input and returns the in-game icon. This template is not specifically a function of this template, but you can then use CSS to resize the icon to 16x16, 32x32, or 64x64used by both [[Template:Item]] and [[Template:Loot]]. Remember that you may lose image quality, see the 64x64 Ice Core in See the Examples section below.
==Syntax==
<pre>
{{Item icon|<name>|<size selection>}}
</pre>
== Parameters ==
; <name>
: The name of the itemicon. It must match exactly what is displayed in-game (e.g. "Red Apple", not "Apple" or "red apple")
: If omitted or empty, template returns a blank icon image.
: If no match is found, template returns an error.
 
; <size selection>
: 1 or 32 for 32x32.
: 2 or 64 for 64x64.
: If omitted, empty, or anything else, image isn't resized.
== Examples ==
=== Standard Use ===
<pre>{{Item icon|Glowy Yellow Crystal}}  {{Item icon|Ice Core}} {{Item icon}} {{Item icon|FakeItemReturnsError}}</pre>{{Item icon|Glowy Yellow Crystal}} {{Item icon|Ice Core}} {{Item icon}} {{Item icon|FakeItemReturnsError}}  === Resizing ===<pre>{{Item icon|Glowy Yellow Crystal}} <!-- default size is 64x64 --> {{Item icon|Ice Core}} <!-- default size is 32x32 --> {{Item icon|Glowy Yellow Crystal|32}} {{Item icon|Ice Core|64}}</pre>{{Item icon|Glowy Yellow Crystal}} <!-- default size is 64x64 -->
{{Item icon}} {{Item icon|FakeItemReturnsErrorIce Core}}</pre!-- default size is 32x32 -->{{Item icon|Glowy Yellow Crystal}} {{Item icon|Ice Core}}
{{Item icon}} {{Item icon|FakeItemReturnsErrorGlowy Yellow Crystal|32}}
{{Item icon|Ice Core|64}}
=== Forcing 32x32 size ===
<pre><span class="extimage32px">{{Item icon|Glowy Yellow Crystal}}</span></pre>
<span class="extimage32px">{{Item icon|Glowy Yellow Crystal}}</span>
=== Alternative Resizing (old method) ===
You can also manually resize the images if you wish (using the template just wraps the image in this span automatically).
 
<pre>
<span class="extimage32px">{{Item icon|Salt}}</span>
 
<span class="extimage64px">{{Item icon|Salt}}</span>
</pre>
<span class="extimage32px">{{Item icon|Salt}}</span>
=== Forcing 64x64 size ===<pre><span class="extimage64px">{{Item icon|Ice CoreSalt}}</span></pre><span class="extimage64px">{{Item icon|Ice Core}}</span>== Notes ===Sometimes items appear in-game that share the same displayed name but have different internal names. Often future patches rename one of them to prevent conflicts, but a few persist. This wiki resolves the issue by renaming the less-likely to be searched for item.
One example is {{Item|Daisy}} and {{Item|Daisy (Lute)}}. Both are called just "Daisy" in-game, but the Lute has an InternalName (found in the items json) of "Daisy" and the flower has an InternalName of "Flower5".
==== Icon Codes for Items Sharing a Name ====
<pre> | Daisy = 5283
| Daisy (Lute) = 5380</pre>
[[Category:Template_documentation]]