Difference between revisions of "Template:Item icon/doc"
From Project: Gorgon Wiki
m |
Extractum11 (talk | contribs) 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 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 | + | : 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|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> | ||
| + | |||
| + | <span class="extimage64px">{{Item icon|Salt}}</span> | ||
| + | </pre> | ||
| + | <span class="extimage32px">{{Item icon|Salt}}</span> | ||
| − | + | <span class="extimage64px">{{Item icon|Salt}}</span> | |
| − | |||
| − | <span class="extimage64px">{{Item icon| | ||
[[Category:Template_documentation]] | [[Category:Template_documentation]] | ||
Revision as of 22:27, 30 September 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}}
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}}
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>
