View source for Template:Nbt/doc

{{Documentation header}}__NOTOC__
[[File:Nbtsheet.png|frame|The sprite sheet]]
This template is used to more clearly illustrate [[NBT Format|NBT]] tags and [[JSON]] fields.

When showing the structure of an NBT file, this template is best coupled with a unordered list, wrapped in a treeview class.

== Usage ==
<pre style="max-width: 326px">{{nbt|<tagname>|display text (optional)}}</pre>

=== Types of tags ===
These are the types of tags ''Minecraft'' uses in its NBT data.
{| class="wikitable"
! Icon
! Tag name(s)
|-
| style="text-align: center" | {{nbt|bool}}       || bool<br>boolean
|-
| style="text-align: center" | {{nbt|byte}}       || byte
|-
| style="text-align: center" | {{nbt|short}}      || short
|-
| style="text-align: center" | {{nbt|int}}        || int<br>integer
|-
| style="text-align: center" | {{nbt|long}}       || long
|-
| style="text-align: center" | {{nbt|float}}      || float
|-
| style="text-align: center" | {{nbt|double}}     || double
|-
| style="text-align: center" | {{nbt|byte array}} || byte array<br>byte-array
|-
| style="text-align: center" | {{nbt|int array}}  || int array<br>int-array<br>integer array<br>integer-array
|-
| style="text-align: center" | {{nbt|long array}}  || long array<br>long-array<br>
|-
| style="text-align: center" | {{nbt|string}}     || string
|-
| style="text-align: center" | {{nbt|list}}       || list
|-
| style="text-align: center" | {{nbt|compound}}   || compound
|}
Note: NBT does not use the boolean type (true/false attributes are usually of byte type), so this type should only be used for JSON.

JSON has no concept of numeric types other than '''double''', nor of arrays that specify their elements' type, so the '''byte''', '''short''', '''int''',  '''long''', '''float''', '''byte array''' and '''int array''' tags should only be used to indicate what type Minecraft will convert a JSON field to after reading it.

== Example ==
<noinclude>{{needs update}}</noinclude>
=== Usage with treeview list ===
<pre>
<nowiki><div class="treeview"></nowiki>
* '''<nowiki>{{nbt|compound}}</nowiki>''' World data.
** '''<nowiki>{{nbt|int|GameType}}</nowiki>''': Whether in survival (0) or in creative (1) mode.
** '''<nowiki>{{nbt|long|LastPlayed}}</nowiki>''': Stores the Unix time stamp (in seconds) when the player saved the game.
** '''<nowiki>{{nbt|string|LevelName}}</nowiki>''': Specifies the name of the level.
** '''<nowiki>{{nbt|int|Platform}}</nowiki>''': Seems to store the platform that the level is created on. Currently observed value is 2.
** '''<nowiki>{{nbt|compound|Player}}</nowiki>''': Player entity information. See [[#Entity Format|Entity Format]] and Mob Entity Format for details. It is missing the id tag and has additional elements:
*** '''<nowiki>{{nbt|int|Dimension}}</nowiki>''': The dimension the player is in. 0 is the Overworld.
*** '''<nowiki>{{nbt|list|Inventory}}</nowiki>''': Each TAG_Compound in this list defines an item the player is carrying or holding.
**** '''<nowiki>{{nbt|compound}}</nowiki>''' Inventory item data
***** '''<nowiki>{{nbt|byte|Slot}}</nowiki>''': Indicates which inventory slot this item is in.
***** '''<nowiki>{{nbt|short|id}}</nowiki>''': [[Bedrock Edition data values|Item or Block ID.]]
***** '''<nowiki>{{nbt|byte|Count}}</nowiki>''': Number of items stacked in this inventory slot. Any item can be stacked, including tools. Range is 1-255. Values above 127 and below -128 are not displayed in-game.
***** '''<nowiki>{{nbt|short|Damage}}</nowiki>''': For tools, the amount of wear they have suffered. The maximum durability of the tool (for example, 33 for golden tools) means undamaged. When the Damage reaches 0, it breaks and disappears.
*** '''<nowiki>{{nbt|int|Score}}</nowiki>''': The score of the player.
** '''<nowiki>{{nbt|long|RandomSeed}}</nowiki>''': Random number providing the Random Seed for the terrain.
** '''<nowiki>{{nbt|long|SizeOnDisk}}</nowiki>''': Estimated size of the entire world in bytes.
** '''<nowiki>{{nbt|int|SpawnX}}</nowiki>''': X coordinate of the player's spawn position. Default is 0.
** '''<nowiki>{{nbt|int|SpawnY}}</nowiki>''': Y coordinate of the player's spawn position. Default is 64.
** '''<nowiki>{{nbt|int|SpawnZ}}</nowiki>''': Z coordinate of the player's spawn position. Default is 0.
** '''<nowiki>{{nbt|int|StorageVersion}}</nowiki>''': Current version of Pocket Edition NBT. Currently 3.
** '''<nowiki>{{nbt|long|Time}}</nowiki>''': Stores the current "time of day" in ticks. There are 20 ticks per real-life second, and 14400 ticks per Minecraft [[day/night cycle]], making the full cycle length 12 minutes—8 minutes shorter than the standard 20 minute day/night cycle. 0 is the start of [[Day/night cycle#Daytime|daytime]], 7200 is the start of [[Day/night cycle#Sunset/Dusk|sunset]], 8280 is the start of [[Day/night cycle#Nighttime|nighttime]], 13320 is the start of [[Day/night cycle#Sunrise/Dawn|sunrise]], and 14400 is daytime again. The value stored in level.dat is always increasing and can be larger than 14400, but the "time of day" is always modulo 14400 of the "Time" field value.
<nowiki></div></nowiki>
</pre>

<div class="treeview">
* {{nbt|compound}} World data.
** {{nbt|int|GameType}}: Whether in survival (0) or in creative (1) mode.
** {{nbt|long|LastPlayed}}: Stores the Unix time stamp (in seconds) when the player saved the game.
** {{nbt|string|LevelName}}: Specifies the name of the level.
** {{nbt|int|Platform}}: Seems to store the platform that the level is created on. Currently observed value is 2.
** {{nbt|compound|Player}}: Player entity information. See [[#Entity Format|Entity Format]] and Mob Entity Format for details. It is missing the id tag and has additional elements:
*** {{nbt|int|Dimension}}: The dimension the player is in. 0 is the Overworld.
*** {{nbt|list|Inventory}}: Each {{cd|Compound}} in this list defines an item the player is carrying or holding.
**** {{nbt|compound}} Inventory item data
***** {{nbt|byte|Slot}}: Indicates which inventory slot this item is in.
***** {{nbt|short|id}}: [[Bedrock Edition data values|Item or Block ID.]]
***** {{nbt|byte|Count}}: Number of items stacked in this inventory slot. Any item can be stacked, including tools. Range is 1-255. Values above 127 and below -128 are not displayed in-game.
***** {{nbt|short|Damage}}: For tools, the amount of wear they have suffered. The maximum durability of the tool (for example, 33 for golden tools) means undamaged. When the Damage reaches 0, it breaks and disappears.
*** {{nbt|int|Score}}: The score of the player.
** {{nbt|long|RandomSeed}}: Random number providing the Random Seed for the terrain.
** {{nbt|long|SizeOnDisk}}: Estimated size of the entire world in bytes.
** {{nbt|int|SpawnX}}: X coordinate of the player's spawn position. Default is 0.
** {{nbt|int|SpawnY}}: Y coordinate of the player's spawn position. Default is 64.
** {{nbt|int|SpawnZ}}: Z coordinate of the player's spawn position. Default is 0.
** {{nbt|int|StorageVersion}}: Current version of Pocket Edition NBT. Currently 3.
** {{nbt|long|Time}}: Stores the current "time of day" in ticks. There are 20 ticks per real-life second, and 14400 ticks per Minecraft [[day/night cycle]], making the full cycle length 12 minutes—8 minutes shorter than the standard 20 minute day/night cycle. 0 is the start of [[Day/night cycle#Daytime|daytime]], 7200 is the start of [[Day/night cycle#Sunset/Dusk|sunset]], 8280 is the start of [[Day/night cycle#Nighttime|nighttime]], 13320 is the start of [[Day/night cycle#Sunrise/Dawn|sunrise]], and 14400 is daytime again. The value stored in level.dat is always increasing and can be larger than 14400, but the "time of day" is always modulo 14400 of the "Time" field value.
</div>

== See also ==
* [[Template:Nbt/sprite]]

<includeonly>
[[Category:Sprite templates]]


</includeonly>
<noinclude>

</noinclude>