Template:Item icon/doc: Difference between revisions

From Project Gorgon
Jump to navigation Jump to search
← Older editNewer edit →
Extractum11 (talk | contribs)
1,690 edits
Alleryn (talk | contribs)
5,698 edits
mNo edit summary
Extractum11 (talk | contribs)
1,690 edits
m Updated documentation
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
==Description==
This accepts an item name as input and returns the in-game icon. This is not specifically a function of this template, but you can then use CSS to resize the icon to 16x16, 32x32, or 64x64. Remember that you may lose image quality, see the 64x64 Ice Core in the Examples section below.
This accepts an item name as input and returns the in-game icon. 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 omitted or empty, template returns a blank icon image.
: If no match is found, template returns an error.
: 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 ==  


=== Standard Use ===
=== Standard Use ===
<pre>{{Item icon|Glowy Yellow Crystal}} {{Item icon|Ice Core}}
<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|FakeItemReturnsError}}</pre>
{{Item icon|Ice Core}} <!-- default size is 32x32 -->
{{Item icon|Glowy Yellow Crystal}} {{Item icon|Ice Core}}


{{Item icon}} {{Item icon|FakeItemReturnsError}}
{{Item icon|Glowy 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 ===
<span class="extimage64px">{{Item icon|Salt}}</span>
<pre><span class="extimage64px">{{Item icon|Ice Core}}</span></pre>
<span class="extimage64px">{{Item icon|Ice Core}}</span>


[[Category:Template_documentation]]
[[Category:Template_documentation]]

Revision as of 03:27, 1 October 2021

Description

This accepts an item name as input and returns the in-game icon. 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}}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5702.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5295.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_.png | http://cdn.projectgorgon.com/v456/icons/icon_.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}}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5702.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5295.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5702.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5295.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}


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>

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5013.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

{{ #replace: http://cdn.projectgorgon.com/v456/icons/icon_5013.png | http://cdn.projectgorgon.com/v456/icons/icon_.png | Error: Item not found }}

Retrieved from "https://wiki.gorgonserver.com//index.php?title=Template:Item_icon/doc&oldid=98736"