Module:Weapon/doc: Difference between revisions

From Inkipedia, the Splatoon wiki
(Documentation.)
 
(Adding ?? option to the documentation)
Line 28: Line 28:
| The English name of the weapon.
| The English name of the weapon.
* For Bomb Rush, specify the bomb type in parenthesis like <code>Bomb Rush (Burst Bomb)</code>.
* For Bomb Rush, specify the bomb type in parenthesis like <code>Bomb Rush (Burst Bomb)</code>.
* For random weapons in [[Salmon Run]], simply use a question mark: ?
* For random weapons in [[Salmon Run]], simply use a question mark: ? for the green random weapon and ?? for the yellow random weapon.
|- style="vertical-align: top;"
|- style="vertical-align: top;"
! size
! size
Line 49: Line 49:
* {{Weapon|S2|Main|Splattershot Jr.|48|icononly}}
* {{Weapon|S2|Main|Splattershot Jr.|48|icononly}}
* {{Weapon|S2|Main|?}}
* {{Weapon|S2|Main|?}}
* {{Weapon|S2|Main|??}}
</pre>
</pre>
=== Output ===
=== Output ===
Line 55: Line 56:
* {{Weapon|S2|Main|Splattershot Jr.|icononly}}
* {{Weapon|S2|Main|Splattershot Jr.|icononly}}
* {{Weapon|S2|Main|Splattershot Jr.|48|icononly}}
* {{Weapon|S2|Main|Splattershot Jr.|48|icononly}}
* {{Weapon|S2|Main|?}}<includeonly>
* {{Weapon|S2|Main|?}}
* {{Weapon|S2|Main|??}}<includeonly>
[[Category:Templates]]</includeonly><noinclude>
[[Category:Templates]]</includeonly><noinclude>
[[Category:Template documentation]]</noinclude>
[[Category:Template documentation]]</noinclude>

Revision as of 12:40, 12 July 2018

Displays an inline weapon icon with a text link.

Usage

{{Weapon|<game>|<category>|<name>|<size>|<icononly>}}

Parameters

Parameter Type Status Description
game Unnamed Required. The game that the ability belongs to. Must be one of the following:
  • S for Splatoon
  • S2 for Splatoon 2
category Unnamed Required The type of weapon. Must be one of the following:
  • Main
  • Sub
  • Special
name Unnamed Required The English name of the weapon.
  • For Bomb Rush, specify the bomb type in parenthesis like Bomb Rush (Burst Bomb).
  • For random weapons in Salmon Run, simply use a question mark: ? for the green random weapon and ?? for the yellow random weapon.
size Unnamed Optional The pixel width for the icon. The default size is 24.
icononly Unnamed Optional If present, the text label will be omitted.

Examples

Markup

* {{Weapon|S|Special|Bomb Rush}}
* {{Weapon|S|Special|Bomb Rush (Seeker)|48}}
* {{Weapon|S2|Main|Splattershot Jr.|icononly}}
* {{Weapon|S2|Main|Splattershot Jr.|48|icononly}}
* {{Weapon|S2|Main|?}}
* {{Weapon|S2|Main|??}}

Output