View source for Template:Spindata/Sleep/doc

{{template|Spindata/Sleep}} is used on a Pokémon species page for data from [[Pokémon Sleep]].
* See also: [[Bulbapedia:Project Pokédex/Structure#Side game data|Bulbapedia:Project Pokédex/Structure → Side game data]]
* Some Pokémon do not fit into this template and thus require a hardcoded subtemplate:
** {{template|Spindata/Sleep/Ditto}}

==Usage==
Should be used with {{template|Spindata/Head}}.
<pre>
{{Spindata/Head|type=}}
|-

{{Spindata/Sleep|col=
|pokemon=
|ndex=
|type=
|sleeptype=
|friendpoints=
|specialty=
|berry=
|ingredient1=
|ingredient2=
|ingredient3=
|skillname=
|skilldesc=
|carrylimit=
|candyNum=
|evolution=
|dexentry=
|sleepstyle1=
|sleepstyle2=
|sleepstyle3=
|sleepstyle4=
}}

|}
</pre>

===Parameters===
All parameters are case sensitive.
{| class="wikitable" style="background: #e5f1ec; margin:1em auto;"
|- 
! style="background: #d1e5d9" | Parameter
! style="background: #d1e5d9" | Allowed values
! style="background: #d1e5d9" | Notes
|-
| col
| ''Number''
| The number of columns this template should span.
|-
| pokemon
| ''String''
| '''Optional.''' The Pokémon's name. Only needed for Pokémon that can evolve.
|-
| ndex
| ''National Pokédex Number''
| The Pokémon's [[List of Pokémon by National Pokédex number|National Pokédex number]].
Add form suffix here.
|-
| type
|style="max-width:460px"| <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>
| The Pokémon's type.
Note that Pokémon are single typed in this game.
|-
| sleeptype
| <code>Dozing</code> • <code>Snoozing</code> • <code>Slumbering</code>
| The Pokémon's [[sleep type]].
|-
| friendpoints
| ''Number''
| The number of points required to befriend this Pokémon.
|-
| specialty
| <code>Berries</code> • <code>Ingredients</code> • <code>Skills</code>
| The Pokémon's gathering specialty.
|-
| berry
| ''String''
| The Berry collected by this Pokémon.
|-
| ingredient1
| ''String''
| The primary ingredient collected by this Pokémon.
|-
| ingredient2
| ''String''
| Other ingredient that can be collected by this Pokémon.
|-
| ingredient3
| ''String''
| '''Optional'''. Third ingredient that can be collected by this Pokémon.
|-
| skillname
| ''String''
| The name of the Pokémon's main {{sleep|skill}}.
|-
| skilldesc
|''String''
| Description of the main skill's effect at skill level 1.
|-
| carrylimit
| ''Number''
| The Pokémon's base carry limit.
|-
| evolution
| ''Wikitext''
| '''Optional.''' The requirement(s) this Pokémon must meet to evolve. Does not include Candy.
For evolutions requiring items, the sprite needs to be added manually.
|-
| candyNum
| ''Number''
| '''Optional.''' Number of Pokémon Candies required for evolution.
|-
| dexentry
| ''String''
| The [[Sleep Style Dex]] description.
|-
| sleepstyle1
| ''String''
| Name of the Pokémon's 1★ sleep style.
|-
| sleepstyle2
| ''String''
| Name of the Pokémon's 2★ sleep style.
|-
| sleepstyle3
| ''String''
| '''Optional.''' Name of the Pokémon's 3★ sleep style.
|-
| sleepstyle4
| ''String''
| '''Optional.''' Name of the Pokémon's 4★ sleep style.
|-
| img1 
|rowspan=4| ''Filename''
|rowspan=4| '''Optional'''. Override for the Sleep Style filename, with extension.
Defaults to <code>Sleep Style &lt;ndex&gt;-#.png</code>
|-
| img2
|-
| img3
|-
| img4
|- class="expandable"
!colspan=3| Only for Special Pokémon
|-
| special
| <code>yes</code>
| Set to <code>yes</code> for a Special Pokémon.
|-
| nature
| ''String''
| The Special Pokémon's nature.
|-
| subskill1
| ''String''
| Level 10 subskill.
|-
| subskill2
| ''String''
| Level 25 subskill.
|-
| subskill3
| ''String''
| Level 50 subskill.
|-
| subskill4
| ''String''
| Level 75 subskill.
|-
| subskill5
| ''String''
| Level 100 subskill.
|}

===TemplateData===
<templatedata>
{
	"params": {
		"col": {
			"label": "Colspan",
			"description": "Number of columns this template should span",
			"type": "number",
			"default": "1",
			"required": true
		},
		"type": {
			"label": "Pokémon Type",
			"description": "The Pokémon's type in Pokémon Sleep.\n(Note that Pokémon are single-typed in this game.)",
			"type": "line",
			"suggestedvalues": [
				"Normal",
				"Fire",
				"Fighting",
				"Water",
				"Flying",
				"Grass",
				"Poison",
				"Electric",
				"Ground",
				"Psychic",
				"Rock",
				"Ice",
				"Bug",
				"Dragon",
				"Ghost",
				"Dark",
				"Steel",
				"Fairy"
			],
			"default": "Unknown",
			"required": true
		},
		"ndex": {
			"label": "NDex",
			"description": "4-digit National Pokédex number",
			"type": "number",
			"required": true
		},
		"special": {
			"label": "Special",
			"description": "Set to \"yes\" for a Special Pokémon",
			"type": "line",
			"suggestedvalues": [
				"yes"
			]
		},
		"sleeptype": {
			"label": "Sleep type",
			"description": "The Pokémon's sleep type",
			"type": "line",
			"suggestedvalues": [
				"Dozing",
				"Snoozing",
				"Slumbering"
			],
			"default": "Unknown",
			"required": true
		},
		"friendpoints": {
			"label": "Points to Befriend",
			"description": "Number of points required to befriend this Pokémon",
			"type": "number",
			"required": true
		},
		"specialty": {
			"label": "Specialty",
			"description": "Area of expertise",
			"type": "line",
			"suggestedvalues": [
				"Berries",
				"Ingredients",
				"Skills"
			],
			"required": true
		},
		"berry": {
			"label": "Berry",
			"description": "Berry collected by this Pokémon",
			"type": "line",
			"required": true
		},
		"ingredient1": {
			"label": "Ingredient 1",
			"description": "Primary ingredient collected",
			"type": "line",
			"required": true
		},
		"ingredient2": {
			"label": "Ingredient 2",
			"description": "Secondary ingredient collected.",
			"type": "line",
			"required": true
		},
		"ingredient3": {
			"label": "Ingredient 3",
			"description": "Third ingredient collected",
			"type": "line",
			"suggested": true
		},
		"skillname": {
			"label": "Main Skill",
			"description": "Main Skill name",
			"type": "line",
			"required": true
		},
		"carrylimit": {
			"label": "Carry Limit",
			"description": "Base carry limit",
			"type": "number",
			"required": true
		},
		"skilldesc": {
			"label": "Main Skill Desc",
			"description": "Main Skill description at skill level 1",
			"type": "line",
			"required": true
		},
		"nature": {
			"label": "Nature",
			"description": "Special Pokémon's nature",
			"type": "line"
		},
		"subskill1": {
			"label": "Subskill 1",
			"description": "Level 10 subskill.",
			"type": "line"
		},
		"subskill2": {
			"label": "Subskill 2",
			"description": "Level 25 subskill.",
			"type": "line"
		},
		"subskill3": {
			"label": "Subskill 3",
			"description": "Level 50 subskill.",
			"type": "line"
		},
		"subskill4": {
			"label": "Subskill 4",
			"description": "Level 75 subskill.",
			"type": "line"
		},
		"subskill5": {
			"label": "Subskill 5",
			"description": "Level 100 subskill.",
			"type": "line"
		},
		"evolution": {
			"label": "Evolution",
			"description": "Evolution requirements, excluding Pokémon Candy",
			"type": "content",
			"suggested": true
		},
		"pokemon": {
			"label": "Pokémon",
			"description": "Pokémon name",
			"type": "line",
			"suggested": true
		},
		"candyNum": {
			"label": "Candies",
			"description": "Number of Pokémon Candies required for evolution",
			"type": "number",
			"suggested": true
		},
		"dexentry": {
			"label": "Dex Entry",
			"description": "Sleep Style Dex description",
			"type": "line",
			"suggested": true
		},
		"img1": {
			"label": "Sleep Style Image 1",
			"description": "Override for the Pokémon's 1-star (★) sleep style image",
			"type": "wiki-file-name"
		},
		"img2": {
			"label": "Sleep Style Image 2",
			"description": "Override for the Pokémon's 2-star (★★) sleep style image",
			"type": "wiki-file-name"
		},
		"sleepstyle3": {
			"label": "Sleep Style 3",
			"description": "3-star (★★★) sleep style name",
			"type": "line",
			"suggested": true
		},
		"img3": {
			"label": "Sleep Style Image 3",
			"description": "Override for the Pokémon's 3-star (★★★) sleep style image",
			"type": "wiki-file-name"
		},
		"sleepstyle4": {
			"label": "Sleep Style 4",
			"description": "4-star (★★★★) sleep style name",
			"type": "line",
			"suggested": true
		},
		"img4": {
			"label": "Sleep Style Image 4",
			"description": "Override for the Pokémon's 4-star (★★★★) sleep style image",
			"type": "wiki-file-name"
		},
		"sleepstyle1": {
			"label": "Sleep Style 1",
			"description": "1-star (★) Sleep Style name",
			"type": "line",
			"required": true
		},
		"sleepstyle2": {
			"label": "Sleep Style 2",
			"description": "2-star (★★) sleep style name",
			"type": "line",
			"suggested": true
		}
	},
	"description": "Spindata/Sleep is used on a Pokémon species page for data from Pokémon Sleep",
	"paramOrder": [
		"col",
		"pokemon",
		"ndex",
		"type",
		"sleeptype",
		"friendpoints",
		"specialty",
		"berry",
		"ingredient1",
		"ingredient2",
		"ingredient3",
		"skillname",
		"skilldesc",
		"carrylimit",
		"evolution",
		"candyNum",
		"dexentry",
		"sleepstyle1",
		"img1",
		"sleepstyle2",
		"img2",
		"sleepstyle3",
		"img3",
		"sleepstyle4",
		"img4",
		"special",
		"nature",
		"subskill1",
		"subskill2",
		"subskill3",
		"subskill4",
		"subskill5"
	],
	"format": "block"
}
</templatedata>

==Examples==
===4 Sleep Styles===
<pre>
{{Spindata/Sleep|col=6
|pokemon=Bellsprout
|type=Grass
|ndex=0069
|sleeptype=Dozing
|friendpoints=5
|specialty=Ingredients
|berry=Durin
|ingredient1=Snoozy Tomato
|ingredient2=Soft Potato
|ingredient3=Large Leek
|skillname=Charge Energy S
|skilldesc=Restores 12 Energy to the user.
|carrylimit=8
|candyNum=40
|evolution=Level 16
|dexentry=When it sleeps with its feet planted deep in the ground, it's said to be taking in water from the soil. Perhaps it feels so safe while sleeping that it forgets that it might need to run away.
|sleepstyle1=Stretched-Out Sleep
|sleepstyle2=Acid-Dripping Sleep
|sleepstyle3=Rooted Sleep
|sleepstyle4=Atop-Belly Sleep
}}
</pre>
{{Spindata/Head|type=Grass}}
{{Spindata/Sleep
|pokemon=Bellsprout
|type=Grass
|ndex=0069
|sleeptype=Dozing
|friendpoints=5
|specialty=Ingredients
|berry=Durin
|ingredient1=Snoozy Tomato
|ingredient2=Soft Potato
|ingredient3=Large Leek
|skillname=Charge Energy S
|skilldesc=Restores 12 Energy to the user.
|carrylimit=8
|candyNum=40
|evolution=Level 16
|dexentry=When it sleeps with its feet planted deep in the ground, it's said to be taking in water from the soil. Perhaps it feels so safe while sleeping that it forgets that it might need to run away.
|sleepstyle1=Stretched-Out Sleep
|sleepstyle2=Acid-Dripping Sleep
|sleepstyle3=Rooted Sleep
|sleepstyle4=Atop-Belly Sleep
}}
|}

===3 Sleep Styles===
<pre>
{{Spindata/Sleep|col=6
|pokemon=Magnemite
|type=Steel
|ndex=0081
|sleeptype=Slumbering
|friendpoints=5
|specialty=Skills
|berry=Belue
|ingredient1=Pure Oil
|ingredient2=Fiery Herb
|skillname=Cooking Power-Up S
|skilldesc=Gives your pot room for 7 more ingredients next time you cook.
|carrylimit=8
|candyNum=40
|evolution=Level 23
|dexentry=The units at its side generate electromagnetic waves that keep it airborne. On rare occasions, perhaps when it sleepily muddles the direction of its waves, it does loops through the air while asleep.
|sleepstyle1=Droopy-Float Sleep
|sleepstyle2=Magnet-Rise Sleep
|sleepstyle3=Upside-Down Sleep
}}
</pre>
{{Spindata/Head|type=Steel}}
{{Spindata/Sleep
|pokemon=Magnemite
|type=Steel
|ndex=0081
|sleeptype=Slumbering
|friendpoints=5
|specialty=Skills
|berry=Belue
|ingredient1=Pure Oil
|ingredient2=Fiery Herb
|skillname=Cooking Power-Up S
|skilldesc=Gives your pot room for 7 more ingredients next time you cook.
|carrylimit=8
|candyNum=40
|evolution=Level 23
|dexentry=The units at its side generate electromagnetic waves that keep it airborne. On rare occasions, perhaps when it sleepily muddles the direction of its waves, it does loops through the air while asleep.
|sleepstyle1=Droopy-Float Sleep
|sleepstyle2=Magnet-Rise Sleep
|sleepstyle3=Upside-Down Sleep
}}
|}

===2 Sleep Styles===
<pre>
{{Spindata/Sleep|col=6
|pokemon=Pikachu
|type=Electric
|ndex=0025 holiday
|sleeptype=Snoozing
|friendpoints=7
|specialty=Skills
|berry=Grepa
|ingredient1=Fancy Apple
|ingredient2=Fancy Egg
|ingredient3=Warming Ginger
|skillname=Dream Shard Magnet S
|skilldesc=Obtain 240 Dream Shards.
|carrylimit=16
|dexentry=While sleeping, it generates electricity in its cheek sacs. Apparently, it may also discharge electricity while it dozes, as if firing off electric shocks in its dreams.
|sleepstyle1=Curled-Up Sleep|img1=Sleep Style 0025-1 holiday.png
|sleepstyle2=Gift-Giving Sleep|img2=Sleep Style 0025-2 holiday.png
}}
</pre>
{{Spindata/Head|type=Electric}}
{{Spindata/Sleep
|pokemon=Pikachu
|type=Electric
|ndex=0025 holiday
|sleeptype=Snoozing
|friendpoints=7
|specialty=Skills
|berry=Grepa
|ingredient1=Fancy Apple
|ingredient2=Fancy Egg
|ingredient3=Warming Ginger
|skillname=Dream Shard Magnet S
|skilldesc=Obtain 240 Dream Shards.
|carrylimit=16
|dexentry=While sleeping, it generates electricity in its cheek sacs. Apparently, it may also discharge electricity while it dozes, as if firing off electric shocks in its dreams.
|sleepstyle1=Curled-Up Sleep|img1=Sleep Style 0025-1 holiday.png
|sleepstyle2=Gift-Giving Sleep|img2=Sleep Style 0025-2 holiday.png
}}
|}

===Special Pokémon===
<pre>
{{Spindata/Sleep|col=6
|pokemon=Raikou
|type=Electric
|ndex=0243
|sleeptype=Snoozing
|friendpoints=30
|specialty=Skills
|berry=Grepa
|ingredient1=Bean Sausage
|ingredient2=Fiery Herb
|ingredient3=Large Leek
|skillname=Helper Boost (Electric)
|skilldesc=Instantly gets you ×2 the usual help from all Pokémon on your team. Meet certain conditions to boost effect.
|carrylimit=22
|special=yes
|nature=Docile
|subskill1=Sleep EXP Bonus
|subskill2=Skill Level Up S
|subskill3=Inventory Up L
|subskill4=Helping Speed S
|subskill5=Skill Trigger S
|dexentry=This Pokémon embodies the speed of lightning. It's said that when Raikou sleeps deeply, you can hear a rumbling like distant thunder in its breath. When it wakes, it sweeps once more across the land, roaring like crashing thunder.
|sleepstyle1=Energy-Storing Sleep
|sleepstyle2=Meditative Sleep
|sleepstyle3=Lightning Sleep
}}
</pre>
{{Spindata/Head|type=Electric}}
{{Spindata/Sleep
|pokemon=Raikou
|type=Electric
|ndex=0243
|sleeptype=Snoozing
|friendpoints=30
|specialty=Skills
|berry=Grepa
|ingredient1=Bean Sausage
|ingredient2=Fiery Herb
|ingredient3=Large Leek
|skillname=Helper Boost (Electric)
|skilldesc=Instantly gets you ×2 the usual help from all Pokémon on your team. Meet certain conditions to boost effect.
|carrylimit=22
|special=yes
|nature=Docile
|subskill1=Sleep EXP Bonus
|subskill2=Skill Level Up S
|subskill3=Inventory Up L
|subskill4=Helping Speed S
|subskill5=Skill Trigger S
|dexentry=This Pokémon embodies the speed of lightning. It's said that when Raikou sleeps deeply, you can hear a rumbling like distant thunder in its breath. When it wakes, it sweeps once more across the land, roaring like crashing thunder.
|sleepstyle1=Energy-Storing Sleep
|sleepstyle2=Meditative Sleep
|sleepstyle3=Lightning Sleep
}}
|}

<noinclude>
[[Category:Documentation templates]]
</noinclude>