Difference between revisions of "Slot Data"

From wiki.vg
Jump to navigation Jump to search
(Removed packet list)
m (Replaced "Not present" with "Omitted" to avoid confusion between the field "Present" and weather the current field "is present" in the payload.)
 
(15 intermediate revisions by 11 users not shown)
Line 1: Line 1:
The '''slot''' data structure is how Minecraft represents an item and its associated data in the [[Protocol|minecraft protocol]]
+
The '''Slot''' data structure is how Minecraft represents an item and its associated data in the [[Protocol|Minecraft Protocol]].
  
== Format ==
+
=== Slot ===
  
The structure consists of at least a short, which gives the item/block ID [http://www.minecraftwiki.net/wiki/Block_ids]. A value of <code>-1</code> signifies that the slot is empty, and no further data follows.
+
{| class="wikitable"
 +
! Name
 +
! Type
 +
! Meaning
 +
|-
 +
| Present
 +
| Boolean
 +
| True if there is an item in this position; false if it is empty.
 +
|-
 +
| Item ID
 +
| Optional VarInt
 +
| The {{Minecraft Wiki|Java Edition data values#Blocks|item ID}}. Omitted if present is false. Item IDs are distinct from block IDs; see [[Data Generators]] for more information
 +
|-
 +
| Item Count
 +
| Optional Byte
 +
| Omitted if present is false.
 +
|-
 +
| NBT
 +
| Optional NBT
 +
| Omitted if present is false. If 0 (TAG_End), there is no NBT data, and no further data follows. Otherwise the byte is the start of an NBT blob as shown below:
 +
|}
  
If the block ID is not <code>-1</code>, three more fields follow. These fields are a byte (item count), a short (item damage), and another short (length of optional NBT data).
+
<pre>
 
+
   COMPOUND <nowiki>''</nowiki>
If the short (length of NBT data) is <code>-1</code>, there is no NBT data, and no further data follows. Otherwise, a byte array will follow.
+
     LIST 'StoredEnchantments'
 
 
The byte array contains gzipped (that is RFC 1952 rather than RFC 1950) [[NBT]] data. The format of this data is as follows:
 
 
 
<code>
 
   COMPOUND: <nowiki>''</nowiki>
 
     LIST: 'ench'
 
 
       COMPOUND
 
       COMPOUND
         SHORT: 'id'
+
         SHORT 'id'
         SHORT: 'lvl'
+
         SHORT 'lvl'
 
       END
 
       END
 
       COMPOUND
 
       COMPOUND
         ...etc
+
         ...
 
       END
 
       END
 +
      ...
 +
    END
 +
    INT 'Unbreakable'
 +
    ...
 
   END
 
   END
</code>
+
</pre>
  
Each of the inner, untagged COMPOUNDs represents an enchantment, with its ID[http://www.minecraftwiki.net/wiki/Enchantment#Enchantment_Types] and level given as child SHORT elements.
+
See [[NBT]] for more information about the NBT format, and {{Minecraft Wiki|Player.dat format#Item structure|here}} for the contained information and its format.  Note that tool durability is included in NBT, among other things.
  
 
== Examples ==
 
== Examples ==
  
<code>
+
<pre>
   ff ff                            | empty slot
+
   00                      | empty slot
   01 16 01 00 00 ff ff             | a diamond pickaxe
+
   01 01 01 00            | a stone block
   01 16 01 00 00 00 04 CA FE BA BE | a diamond pickaxe with (made-up) NBT data
+
   01 01 01 04 CA FE BA BE | a stone block with (made-up) NBT data
</code>
+
</pre>
 +
 
 +
[[Category:Protocol Details]]
 +
[[Category:Minecraft Modern]]

Latest revision as of 23:53, 17 March 2020

The Slot data structure is how Minecraft represents an item and its associated data in the Minecraft Protocol.

Slot

Name Type Meaning
Present Boolean True if there is an item in this position; false if it is empty.
Item ID Optional VarInt The item ID. Omitted if present is false. Item IDs are distinct from block IDs; see Data Generators for more information
Item Count Optional Byte Omitted if present is false.
NBT Optional NBT Omitted if present is false. If 0 (TAG_End), there is no NBT data, and no further data follows. Otherwise the byte is the start of an NBT blob as shown below:
  COMPOUND ''
    LIST 'StoredEnchantments'
      COMPOUND
        SHORT 'id'
        SHORT 'lvl'
      END
      COMPOUND
        ...
      END
      ...
    END
    INT 'Unbreakable'
    ...
  END

See NBT for more information about the NBT format, and here for the contained information and its format. Note that tool durability is included in NBT, among other things.

Examples

  00                      | empty slot
  01 01 01 00             | a stone block
  01 01 01 04 CA FE BA BE | a stone block with (made-up) NBT data