Difference between revisions of "Template:Item icon/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
(Created page with "__NOTOC__ ==Description== This accepts an item name as input and returns the in-game icon. Be aware that icons have various sizes, you should use CSS to easily resize them. Se...")
 
m (Slightly improved documentation.)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
==Description==
 
==Description==
−
This accepts an item name as input and returns the in-game icon. Be aware that icons have various sizes, you should use CSS to easily resize them. See the Examples section below.
+
This template accepts an item name as input and returns the in-game icon. This template is used by both [[Template:Item]] and [[Template:Loot]]. See the Examples section below.
  
 
==Syntax==
 
==Syntax==
 
<pre>
 
<pre>
−
{{Item icon|<name>}}
+
{{Item icon|<name>|<size selection>}}
 
</pre>
 
</pre>
  
 
== Parameters ==
 
== Parameters ==
 
; <name>
 
; <name>
−
: The name of the item. It must match exactly what is displayed in-game (e.g. "Red Apple", not "Apple" or "red apple")
+
: The name of the icon. 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 ==  
 
== Examples ==  
  
−
=== Basic Use ===
+
=== Standard Use ===
−
<pre>{{Item icon|Glowy Yellow Crystal}}</pre>
+
<pre>
 +
{{Item icon|Glowy Yellow Crystal}}
 +
 
 +
{{Item icon|Ice Core}}
 +
 
 +
{{Item icon}}
 +
 
 +
{{Item icon|FakeItemReturnsError}}
 +
</pre>
 
{{Item icon|Glowy Yellow Crystal}}
 
{{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|Ice Core}} <!-- default size is 32x32 -->
 +
 +
{{Item icon|Glowy Yellow Crystal|32}}
 +
 +
{{Item icon|Ice Core|64}}
 +
 +
 +
=== 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>
  
−
=== Forcing 32x32 size ===
+
<span class="extimage64px">{{Item icon|Salt}}</span>
−
<pre><div class="extimage32px">{{Item icon|Glowy Yellow Crystal}}</div></pre>
+
</pre>
−
<div class="extimage32px">{{Item icon|Glowy Yellow Crystal}}</div>
+
<span class="extimage32px">{{Item icon|Salt}}</span>
  
 +
<span class="extimage64px">{{Item icon|Salt}}</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.
  
−
=== Forcing 64x64 size ===
+
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".
−
<pre><div class="extimage64px">{{Item icon|Glowy Yellow Crystal}}</div></pre>
+
==== Icon Codes for Items Sharing a Name ====
−
<div class="extimage64px">{{Item icon|Glowy Yellow Crystal}}</div>
+
<pre> | Daisy = 5283
 +
| Daisy (Lute) = 5380</pre>  
 +
[[Category:Template_documentation]]

Latest revision as of 12:34, 6 December 2023

Description

This template accepts an item name as input and returns the in-game icon. This template is used by both Template:Item and Template:Loot. See the Examples section below.

Syntax

{{Item icon|<name>|<size selection>}}

Parameters

<name>
The name of the icon. 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

{{Item icon|Glowy Yellow Crystal}}

{{Item icon|Ice Core}}

{{Item icon}}

{{Item icon|FakeItemReturnsError}}

icon_5702.png

icon_5295.png

Item-icon-none.png

Error: Item not found


Resizing

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

icon_5702.png

icon_5295.png

icon_5702.png

icon_5295.png


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). 

<span class="extimage32px">{{Item icon|Salt}}</span>

<span class="extimage64px">{{Item icon|Salt}}</span>

icon_5013.png

icon_5013.png

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
icon_5380.png
 
and
Error: Item not found
 
. 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

		| Daisy = 5283
		| Daisy (Lute) = 5380
Retrieved from "http://wiki.projectgorgon.com/w/index.php?title=Template:Item_icon/doc&oldid=136617"