Template:MoveInfobox/doc: Difference between revisions

Rewritten to include all parameters
(Someone, add the {{documentation}} template to Template:MoveInfobox)
 
(Rewritten to include all parameters)
Line 1: Line 1:
{{incomplete|template documentation|Requires updating to describe the current version of the template (move learnability by TM/HM/TR/tutor fields, etc.)}}
This infobox template is used on [[move]] pages to outline different stats and information.
{| style="margin: auto; border: 1px solid #88a; border-collapse: collapse; background: #f7f8ff;" border="1" cellpadding="2" cellspacing="0"
 
==How to use==
Infoboxes should be used at the beginning of the page, before any introductory text.
 
===Parameters===
All parameters are case sensitive.
{| class="wikitable" style="background: #e5f1ec;"
|-  
! style="background: #d1e5d9" | Parameter
! style="background: #d1e5d9" | Allowed values
! style="background: #d1e5d9" | Notes
|-
| <code>n</code>
| ''Number''
| Move number (The number is not displayed but may be useful when creating automatic cross-references). '''Do not''' prefix zeroes.
|-
| <code>name</code>
| ''String''
| Name in English
|-
| <code>jname</code>
| ''String''
| Name in Japanese
|-
| <code>jtrans</code>
| ''String''
| Translation of the Japanese name
|-
| <code>jtranslit</code>
|''String''
| Japanese name in {{wp|Romanization of Japanese|rōmaji}}
|-
| <code>gameimage</code>
| ''File name''
| Screenshot from a game showing the move. '''Don't''' include <code>File:</code>.
|-
| <code>gameimage2</code>
| ''File name''
| '''Optional'''. Second screenshot from a game showing the move. '''Don't''' include <code>File:</code>.
|-
| <code>gameimagewidth</code>
| ''Number''
| Width of the images in pixels. '''Don't''' include <code>px</code>.
|-
| <code>type</code>
| <code>Normal</code> • <code>Fire</code> • <code>Fighting</code> • <code>Water</code> • <code>Flying</code> • <code>Grass</code> • <code>Poison</code> • <code>Electric</code> • <code>Ground</code> • <code>Psychic</code> • <code>Rock</code> • <code>Ice</code> • <code>Bug</code> • <code>Dragon</code> • <code>Ghost</code> • <code>Dark</code> • <code>Steel</code> • <code>Fairy</code> • <code>Shadow</code> • <code>Unknown</code>
| The [[type]] of move. Defaults to <code>Unknown</code>.
|-
| <code>damagecategory</code>
| <code>Physical</code> • <code>Special</code> • <code>Status</code>
| The [[Damage category|category]] of the move.
|-
| <code>basepp</code>
| ''Number''
| Base [[PP]]
|-
|-
! colspan="2" style="background: #ccf; text-align: center;" | Move Infobox Parameters
| <code>maxpp</code>
| ''Number''
| Maximum [[PP]] (usually 160% of base)
|-
|-
! n
| <code>power</code>
| Number of move<ref name="idno"/>
| ''Number''
| Move [[power]]. If no power, type <code>—</code>.
|-
|-
! name
| <code>accuracy</code>
| English name
| ''Number''
| Move [[accuracy]] (Give 99.6% as 100%). If no accuracy, type <code>—</code>. '''Don't''' include <code>%</code>.
|-
|-
! jname
| <code>priority</code>
| Japanese name
| <code>+5</code> • <code>+4</code> • <code>+3</code> • <code>+2</code> • <code>+1</code> • <code>-1</code> • <code>-3</code> • <code>-4</code> • <code>-5</code> • <code>-6</code> • <code>-7</code>
| Move [[priority]]. Moves with 0 priority should '''not''' include this parameter.
|-
|-
! jtrans
| <code>touches</code>
| Japanese name translated
| <code>yes</code> • <code>no</code>
| Does the move make [[contact]] with the opponent?
|-
|-
! type
| <code>protect</code>
| [[Type]] of move
| <code>yes</code> • <code>no</code>
| Is the move affected by {{m|Protect}}?
|-
|-
! basepp
| <code>magiccoat</code>
| Base PP
| <code>yes</code> • <code>no</code>
| Do {{m|Magic Coat}} and {{a|Magic Bounce}} protect against this move?
|-
|-
! maxpp
| <code>snatch</code> <br /> <small><span style="color:red">'''Deprecated:'''</span><code>snatchable</code></small>
| Maximum PP (usually 160% of base)
| <code>yes</code> • <code>no</code>
| Is the move affected by {{m|Snatch}}?
|-
|-
! power
| <code>mirrormove</code>
| Power
| <code>yes</code> • <code>no</code>
| Is the move affected by {{m|Mirror Move}}?
|-
|-
! accuracy
| <code>kingsrock</code> <br /> <small><span style="color:red">'''Deprecated:'''</span><code>useskingsrock</code></small>
| Accuracy (don't append %)<ref name="accuracy"/>
| <code>yes</code> • <code>no</code>
| Does using [[King's Rock]] and this move cause the opponent to flinch?
|-
| <code>sound</code>
| <code>yes</code> • <code>no</code>
| Is this move considered a sound move? (See {{a|Soundproof}}).
|-
| <code>field</code>
| <code>yes</code> • <code>no</code>
| Is the move usable outside of battle? (If <code>yes</code>, the article is added to [[:Category:Moves usable outside of battle]])
|-
| <code>target</code>
| <code>any</code> <small>(May affect anyone but the user)</small> <br /> <code>anyadjacent</code> <small>(May affect anyone adjacent to the user)</small> <br /> <code>all</code>  <small>(Affects all Pokémon on the field)</small> <br /> <code>alladjacent</code> <small>(Affects all Pokémon adjacent to the user)</small> <br /> <code>allothers</code> <small>(Affects all but the user)</small> <br /> <code>foes</code> <small>(Affects all foes)</small> <br/> <code>adjacentfoes</code> <small>(Affects all adjacent foes, but not allies)</small> <br /> <code>foe</code> <small>(May affect any foe, but not allies)</small> <br /> <code>adjacentfoe</code> <small>(May affect any adjacent foe, but not allies)</small> <br /> <code>self</code> <small>(Affects the user)</small> <br /> <code>allies</code> <small>(Affects all allies)</small> <br /> <code>ally</code> <small>(Affects an ally)</small> <br /> <code>adjacentally</code> <small>(Affects an adjacent ally)</small> <br /> <code>team</code> <small>(Affects the user and all allies)</small> <br /> <code>selfadjacentally</code> <small>(May affect the user or an adjacent ally)</small> <br /> <code>twoteam</code> <small>(Affects the user and one ally)</small> <br /> <code>&nbsp;&nbsp;</code> <small>(Does not affect any Pokémon)</small>
| The target of the move.
 
"Any" means that a single target may be chosen from among the targets in range. "All" means that all targets in range are hit. "Adjacent" refers to a Pokémon's position in a [[Double Battle]] or a [[Triple Battle]] with respect to the user of the move.
|-  
|-  
! priority
| <code>gen</code>
| [[Priority]]<ref name="priority"/>
| ''{{wp|Roman numerals|Roman numeral}}''
| The [[generation]] in which the move was introduced.
|-
| colspan=3 |
{| class="wikitable mw-collapsible mw-collapsed" style="background: #e5f1ec; width: 100%"
|-
! colspan=3 | Parameters for TM, TR, HM, or Move Tutor moves (all optional)
|-  
|-  
! category
! style="background: #d1e5d9" | Parameter
| [[Contest condition|Contest category]]<ref name="contest"/>
! style="background: #d1e5d9" | Allowed values
! style="background: #d1e5d9" | Notes
|-
| <code>tm1</code>
: <code>tm#1</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation I]]?
: The number of the TM from Generation I
|-
| <code>tm2</code>
: <code>tm#2</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation II]]?
: The number of the TM from Generation II
|-
| <code>tm3</code>
: <code>tm#3</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation III]]?
: The number of the TM from Generation III
|-
| <code>tm4</code>
: <code>tm#4</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation IV]]?
: The number of the TM from Generation IV
|-
| <code>tm5</code>
: <code>tm#5</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation V]]?
: The number of the TM from Generation V
|-
| <code>tm6</code>
: <code>tm#6</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Generation VI]]?
: The number of the TM from Generation VI
|-
| <code>tmxy</code>
: <code>tm#xy</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Pokémon X and Y]]?
: The number of the TM from Pokémon X and Y
|-
| <code>tmoras</code>
: <code>tm#oras</code>
| <code>yes</code>
: ''Number''
| Is this a TM in [[Pokémon Omega Ruby and Alpha Sapphire]]?
: The number of the TM from Pokémon Omega Ruby and Alpha Sapphire
|-
| <code>tm7</code>
: <code>tm#7</code>
| <code>yes</code>
: ''Number''
| Is this a TM in in [[Pokémon Sun and Moon|Pokémon Sun, Moon]], [[Pokémon Ultra Sun and Ultra Moon|Ultra Sun, and Ultra Moon]]?
: The number of the TM from Pokémon Sun, Moon, Ultra Sun, and Ultra Moon
|-
| <code>tmpe</code>
: <code>tm#pe</code>
| <code>yes</code>
: ''Number''
| Is this a TM in in [[Pokémon: Let's Go, Pikachu! and Let's Go, Eevee!]]?
: The number of the TM from Pokémon: Let's Go, Pikachu! and Let's Go, Eevee!
|-
| <code>tm8</code>
: <code>tm#8</code>
| <code>yes</code>
: ''Number''
| Is this a TM in in [[Generation VIII]]?
: The number of the TM from Generation VIII
|-
| <code>tr8</code>
: <code>tr#8</code>
| <code>yes</code>
: ''Number''
| Is this a TR in in [[Generation VIII]]?
: The number of the TR from Generation VIII
|-
| <code>hm1</code>
: <code>hm#1</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation I]]?
: The number of the HM from Generation I
|-
| <code>hm2</code>
: <code>hm#2</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation II]]?
: The number of the HM from Generation II
|-
| <code>hm3</code>
: <code>hm#3</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation III]]?
: The number of the HM from Generation III
|-
| <code>hmrse</code>
: <code>hm#rse</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in {{game2|Ruby|Sapphire|Emerald}}?
: The number of the HM from Pokémon Ruby, Sapphire, and Emerald
|-
| <code>hm4</code>
: <code>hm#4</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation IV]]?
: The number of the HM from Generation IV
|-
| <code>hmdppt</code>
: <code>hm#dppt</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in {{game2|Diamond|Pearl|Platinum}}?
: The number of the HM from Pokémon Diamond, Pearl, and Platinum
|-
| <code>hmhs</code>
: <code>hm#hs</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in {{game|HeartGold and SoulSilver|s}}?
: The number of the HM from Pokémon HeartGold and SoulSilver
|-
|-
! appeal
| <code>hm5</code>
| Points gained in contests
: <code>hm#5</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation V]]?
: The number of the HM from Generation V
|-
|-
! jam
| <code>hm6</code>
| Points negated in opponents
: <code>hm#6</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Generation VI]]?
: The number of the HM from Generation VI
|-
|-
! cdesc, scdesc, cdesc6
| <code>hmoras</code>
| Additional effects in contests<ref name="contest-eff"/>
: <code>hm#oras</code>
| <code>yes</code>
: ''Number''
| Is this a HM in in [[Pokémon Omega Ruby and Alpha Sapphire]]?
: The number of the HM from Pokémon Omega Ruby and Alpha Sapphire
|-
|-
! pokeforurl
| <code>mtc</code>
| Key for accessing PokéFor's Movedex<ref name="pokefor"/>
| <code>yes</code>
| Is this from a [[Move Tutor]] in {{game|Crystal}}?
|-
|-
! footnotes
| <code>mtxd</code>
| Footnotes<ref name="footnotes"/>
| <code>yes</code>
|}
| Is this from a Move Tutor in [[Pokémon XD: Gale of Darkness]]?
<references>
|-
<ref name="idno">The number is not displayed, but may be useful when creating automatic cross-references. Do not prefix zeroes.</ref>
| <code>mtfl</code>
<ref name="accuracy">Give 99.6% as 100%.</ref>
| <code>yes</code>
<ref name="priority">For moves that have priority not equal to 0.</ref>
| Is this from a Move Tutor in {{game|FireRed and LeafGreen|s}}?
<ref name="contest">One of '''Cool''', '''Beauty''', '''Cute''', '''Smart''' or '''Tough'''.</ref>
|-
<ref name="contest-eff">The additional effects are described in the '''contest moves''' panel.</ref>
| <code>mte</code>
<ref name="pokefor">The PokéFor Movedex key is usually the lowercase of the English name, substituting '''+''' for spaces.</ref>
| <code>yes</code>
<ref name="footnotes">Leave blank if no footnotes.</ref>
| Is this from a Move Tutor in {{game|Emerald}}?
</references>
 
{| style="margin: auto; border: 1px solid #88a; border-collapse: collapse; background: #f7f8ff;" border="1" cellpadding="2" cellspacing="0"
|-
|-
! colspan="2" style="background: #ccf; text-align: center;" | Move properties
| <code>mtdp</code>
| <code>yes</code>
| Is this from a Move Tutor in {{game|Diamond and Pearl|s}}?
|-
|-
! touches
| <code>mtpt</code>
| Does the move make [[contact]] with the opponent?
| <code>yes</code>
| Is this from a Move Tutor in {{game|Platinum}}?
|-
|-
! misses
| <code>mths</code>
| Can the move miss?
| <code>yes</code>
| Is this from a Move Tutor in {{game|HeartGold and SoulSilver|s}}?
|-
|-
! snatchable
| <code>mtbw</code>
| Is the move {{m|Snatch}}able?
| <code>yes</code>
| Is this from a Move Tutor in {{game|Black and White|s}}?
|-
|-
! magiccoat
| <code>mtb2w2</code>
| Do {{m|Magic Coat}} and {{a|Magic Bounce}} protect against this move?
| <code>yes</code>
| Is this from a Move Tutor in {{game|Black and White|s|Pokémon Black 2 and White 2|2}}?
|-
|-
! useskingsrock
| <code>mtxy</code>
| Does using [[King's Rock]] and this move cause the opponent to flinch?
| <code>yes</code>
| Is this from a Move Tutor in [[Pokémon X and Y]]?
|-
|-
! sound
| <code>mtoras</code>
| Is this move considered a sound move? (See {{a|Soundproof}})
| <code>yes</code>
|}
| Is this from a Move Tutor in [[Pokémon Omega Ruby and Alpha Sapphire]]?
All values take either a '''yes''' or '''no''' (case-sensitive).
 
Below are the values for the target parameter, and the text that will be shown in the infobox for that value. "Any" means that a single target may be chosen from among the targets in range. "All" means that all targets in range are hit. "Adjacent" refers to a Pokémon's position in [[Double Battle]]s or [[Triple Battle]]s with respect to the user of the move.
{| style="margin: auto; border: 1px solid #88a; border-collapse: collapse; background: #f7f8ff;" border="1" cellpadding="2" cellspacing="0"
|-
|-
! colspan="2" style="background: #ccf; text-align: center;" | Valid target values
| <code>mtsm</code>
| <code>yes</code>
| Is this from a Move Tutor in [[Pokémon Sun and Moon]]?
|-
|-
| any
| <code>mtusum</code>
| May affect anyone but the user
| <code>yes</code>
| Is this from a Move Tutor in [[Pokémon Ultra Sun and Ultra Moon]]?
|-
|-
| anyadjacent
| <code>mtpe</code>
| May affect anyone adjacent to the user
| <code>yes</code>
| Is this from a Move Tutor in [[Pokémon: Let's Go, Pikachu! and Let's Go, Eevee!]]?
|-
|-
| all
| <code>mtswsh</code>
| Affects all Pokémon on the field
| <code>yes</code>
| Is this from a Move Tutor in [[Pokémon Sword and Shield]]?
|-
|-
| alladjacent
| <code>mtioa</code>
| Affects all Pokémon adjacent to the user
| <code>yes</code>
| Is this from a Move Tutor in [[The Isle of Armor]]?
|-
|-
| allothers
| <code>na</code>
| Affects all but the user
| <code>yes</code> • <code>no</code>
| Is it '''Not''' a [[TM]], [[TR]], [[HM]], or [[Move Tutor]] move? (Defaults to <code>yes</code>)
'''Must''' be set to <code>no</code> if any other TM, TR, HM, or Move Tutor options have been set.
|}
|-
|-
| foes
| <code>category</code>
| Affects all foes
| <code>Cool</code> • <code>Beautiful</code> • <code>Cute</code> • <code>Clever</code> • <code>Tough</code>
| [[Contest condition]]
|-
|-
| adjacentfoes
| <code>appeal</code>
| Affects all adjacent foes, but not allies
| ''Number''
| The number of [[Appeal]] Points the move scores in [[Pokémon Contest]]
|-
|-
| foe
| <code>jam</code>
| May affect any foe, but not allies
| ''Number''
| The number of Appeal Points lost when the move is used for [[jamming]] in Pokémon Contest
|-
|-
| adjacentfoe
| <code>cdesc</code>
| May affect any adjacent foe, but not allies
| ''String''
| The move description from Pokémon Contest
|-
|-
| self
| <code>appealsc</code>
| Affects the user
| ''Number''
| The number of Appeal Points the move scores in [[Pokémon Super Contest]]
|-
|-
| allies
| <code>scdesc</code>
| Affects all allies
| ''String''
| The move description from Pokémon Super Contest
|-
|-
| ally
| <code>category6</code>
| Affects an ally
| <code>Cool</code> • <code>Beautiful</code> • <code>Cute</code> • <code>Clever</code> • <code>Tough</code>
| '''Optional'''. Only used if the contest condition in [[Pokémon Contest|Pokémon Contest Spectaculars]] are different from the value in the <code>category</code> parameter.
|-
|-
| adjacentally
| <code>appeal6</code>
| Affects an adjacent ally
| ''Number''
| The number of Appeal Points the move scores in Pokémon Contest Spectaculars
|-
|-
| team
| <code>jam6</code>
| Affects the user and all allies
| ''Number''
| The number of Appeal Points lost when the move is used for jamming in Pokémon Contest Spectaculars
|-
|-
| selfadjacentally
| <code>cdesc6</code>
| May affect the user or an adjacent ally
| ''String''
| The move description from Pokémon Contest Spectaculars
|-
|-
| twoteam
| <code>footnotes</code>
| Affects the user and one ally
| ''String''
| '''Optional'''. Allows for footnotes to be added to the bottom of the infobox.
|-
|-
| ''(other values)''
| <code>spm</code>
| Does not affect any Pokémon
| <code>0</code> • <code>1</code>
| Hides the links to Smogon's Movedex (along with anything added to <code>footnotes</code>) if set to <code>1</code>. Defaults to <code>0</code>.
|}
|}


==Example==
===Example===
{{MoveInfoboxNoncat
{{MoveInfoboxNoncat
|n=344
| n = 63
|name=Volt Tackle
| name = Hyper Beam
|jname=ボルテッカー
| jname = はかいこうせん
|jtrans=Volteccer
| jtrans = Destruction Beam
|desc=The user electrifies itself, then charges at the foe. It causes considerable damage to the user as well.
| jtranslit = Hakai Kōsen
|gameimage=Volt Tackle IV.png
| gameimage = Hyper Beam VIII.png
|type=Electric
| gameimage2 = Hyper Beam VIII 2.png
|damagecategory=Physical
| gameimagewidth = 300
|basepp=15
| type = Normal
|maxpp=24
| damagecategory = Special
|power=120
| basepp = 5
|accuracy=100
| maxpp = 8
|bdesc=User is hit by recoil that is equal to one-third of the damage inflicted.
| power = 150
|category=Cool
| accuracy = 90
|appeal=6
| touches = no
|jam=0
| protect = yes
|gen=III|
| magiccoat = no
cdesc=User will be more easily startled afterwards.
| snatch = no
|appealsc=2
| mirrormove = yes
|scdesc=Earn +3 if the Pokémon that just went hit max Voltage.
| kingsrock = yes
|pokefordex=volt+tackle
| sound = no
|touches=yes
| field = no
|protect=yes
| target = anyadjacent
|magiccoat=no
| gen = I
|snatch=no
| tm1 = yes
|brightpowder=yes
| tm#1 = 15
|kingsrock=yes
| tm2 = yes
|flag7=no
| tm#2 = 15
|flag8=yes
| tm3 = yes
|sound=no
| tm#3 = 15
|target=foe
| tm4 = yes
|footnotes= }}
| tm#4 = 15
| tm5 = yes
| tm#5 = 15
| tm6 = yes
| tm#6 = 15
| tm7 = yes
| tm#7 = 15
| tm8 = yes
| tm#8 = 08
| tmpe = yes
| tm#pe = 48
| na = no
| category = Cool
| appeal = 4
| jam = 4
| cdesc = Jams the others, and misses one turn of appeals.
| appealsc = 2
| scdesc = Earn +3 if the Pokémon that just went hit max Voltage.
| appeal6 = 4
| jam6 = 4
| cdesc6 = Startles all other Pokémon. User cannot act in the next turn.
}}


<pre>
<pre>
{{MoveInfobox
{{MoveInfobox
|n=344
| n = 63
|name=Volt Tackle
| name = Hyper Beam
|jname=ボルテッカー
| jname = はかいこうせん
|jtrans=Volteccer
| jtrans = Destruction Beam
|desc=The user electrifies itself, then charges at the foe. It causes considerable damage to the user as well.
| jtranslit = Hakai Kōsen
|gameimage=DPVolttackleani.gif
| gameimage = Hyper Beam VIII.png
|type=Electric
| gameimage2 = Hyper Beam VIII 2.png
|damagecategory=Physical
| gameimagewidth = 300
|basepp=15
| type = Normal
|maxpp=24
| damagecategory = Special
|power=120
| basepp = 5
|accuracy=100
| maxpp = 8
|bdesc=User is hit by recoil that is equal to one-third of the damage inflicted.
| power = 150
|category=Cool
| accuracy = 90
|appeal=6
| touches = no
|jam=0
| protect = yes
|gen=III|
| magiccoat = no
cdesc=User will be more easily startled afterwards.
| snatch = no
|appealsc=2
| mirrormove = yes
|scdesc=Earn +3 if the Pokémon that just went hit max Voltage.
| kingsrock = yes
|pokefordex=volt+tackle
| sound = no
|touches=yes
| field = no
|protect=yes
| target = anyadjacent
|magiccoat=no
| gen = I
|snatch=no
| tm1 = yes
|brightpowder=yes
| tm#1 = 15
|kingsrock=yes
| tm2 = yes
|flag7=no
| tm#2 = 15
|flag8=yes
| tm3 = yes
|sound=no
| tm#3 = 15
|footnotes=}}</pre>
| tm4 = yes
| tm#4 = 15
| tm5 = yes
| tm#5 = 15
| tm6 = yes
| tm#6 = 15
| tm7 = yes
| tm#7 = 15
| tm8 = yes
| tm#8 = 08
| tmpe = yes
| tm#pe = 48
| na = no
| category = Cool
| appeal = 4
| jam = 4
| cdesc = Jams the others, and misses one turn of appeals.
| appealsc = 2
| scdesc = Earn +3 if the Pokémon that just went hit max Voltage.
| appeal6 = 4
| jam6 = 4
| cdesc6 = Startles all other Pokémon. User cannot act in the next turn.
}}
</pre><noinclude>
[[Category:Documentation templates]]</noinclude>