Differences

This shows you the differences between two versions of the page.

--- tutorial:blockentity_sync_itemstack [2023/09/24 18:54] – Use new minecraft wiki mattidragon
+++ tutorial:blockentity_sync_itemstack [2024/08/27 02:37] (current) – [Block drops with data] solidblock
@@ Line 3: / Line 3: @@
 ===== Introduction =====
-When you create a ''Block'' with ''BlockEntity'', you might want to place the block with predefined Nbt data from an ''ItemStack'' (of your ''BlockItem''), or save the ''BlockEntity'' data in the ''ItemStack'' after breaking the block.
+When you create a block with block entity, you might want to place the block with predefined NBT data from an ''ItemStack'' (of your ''BlockItem''), or save the ''BlockEntity'' data in the ''ItemStack'' after breaking the block.
-Before proceeding, you will need a [[tutorial:blocks|Block (with BlockItem)]], a [[tutorial:blockentity|BlockEntity]] and a way to [[tutorial:blockentity_modify_data|modify the BlockEntity's data]] for testing purposes.
+In this tutorial, we assume you have created a [[blocks|block]] (and block item) and the [[blockentity|block entity]], and [[blockentity_modify_data|stored data for it]].
-===== Block Drops with data =====
+===== Block drops with data =====
-For a block to drop an ''ItemStack'' with the **Nbt** from the ''BlockEntity'' of the broken block, we only need to change the //loot table//:
+For a block to drop an ''ItemStack'' with the NBT or data components from the ''BlockEntity'' of the broken block, we only need to change the //loot table//.
+==== For versions since 1.20.5 ====
+As data components have been introduced, you need to store the block entity data in the data components of the block item. This requires you to store nbt data as data components. See [[blockentity_modify_data#using_data_components]] about it.
+**If you'are using versions before 1.21**, replace the word **''loot_table''** with **''loot_tables''** in the path.
+<code JavaScript src/main/resources/data/tutorial/loot_table/blocks/demo_block.json>
+{
+  "pools": [
+    {
+      "rolls": 1.0,
+      "bonus_rolls": 0.0,
+      "entries": [
+        {
+          "name": "tutorial:demo_block",
+          "type": "minecraft:item"
+        }
+      ],
+      "conditions": [
+        {
+          "condition": "minecraft:survives_explosion"
+        }
+      ]
+    }
+  ],
+  "functions": [
+    {
+      "source": "block_entity",
+      "include": [
+        "tutorial:number"
+      ],
+      "function": "minecraft:copy_components"
+    }
+  ]
+}
+</code>
+where:
+  * ''%%"include"%%'': the IDs of the data component types.
+==== For versions before 1.20.5 ====
+Before version 1.20.5, data components were not introduced. Therefore, just copy nbt.
 <code JavaScript src/main/resources/data/tutorial/loot_tables/blocks/demo_block.json>
@@ Line 41: / Line 83: @@
 </code>
-Where:
+where:
-  * //**source**// is the Tag key String we used in the ''writeNbt'' and ''readNbt'' methods in our ''DemoBlockEntity'' class -- //"number"//
+  * ''%%"source"%%'' is the key of the nbt we used in the ''writeNbt'' and ''readNbt'' methods in our ''DemoBlockEntity'' class -- ''%%"number"%%''
-  * //**target**// is the Tag key hierarchy in the dropped ''ItemStack'' (//source// prefixed with the //"BlockEntityTag"// key, which is needed for placing the block back with the saved data) -- //"BlockEntityTag.number"//
+  * ''%%"target"%%'' is the hierarchy in the nbt of dropped ''ItemStack'' (''source'' prefixed with the ''%%"BlockEntityTag"%%'' key, which is needed for placing the block back with the saved data) -- ''%%"BlockEntityTag.number"%%''
-To save more fields, just add more replace operations (with source, target and op) to the //"ops"// array.
+To save more fields, just add more replace operations (with source, target and op) to the ''%"ops"%%'' array.
-===== Reading saved data from ItemStack =====
+===== Reading saved data in the tooltip =====
-To get the BlockEntity's **Nbt**, we can use the helper ''BlockItem.getBlockEntityNbt(stack)'' method, which just calls ''stack.getSubNbt(BLOCK_ENTITY_TAG_KEY)'' internally. (BLOCK_ENTITY_TAG_KEY being "BlockEntityTag", already mentioned in the //loot table//).
+For versions since 1.20.5, to get the BlockEntity's data stored in the item stack, we can use get its data component.
-<code java>
+**For versions since 1.20.5:**
-public class DemoBlock extends Block implements BlockEntityProvider {
+<code java DemoBlock.class>
+public class DemoBlock extends BlockWithEntity {
     [...]
     @Override
-    public void appendTooltip(ItemStack stack, BlockView world, List<Text> tooltip, TooltipContext context) {
+    public void appendTooltip(ItemStack stack, Item.TooltipContext context, List<Text> tooltip, TooltipType options) {
-        NbtCompound nbt = BlockItem.getBlockEntityNbt(stack);
+        final Integer i = stack.get(TutorialDataComponentTypes.NUMBER);
-        if (nbt == null) return;
+        if (i == null) return;
-        tooltip.add(Text.literal("Number: "+nbt.getInt("number"))
+        tooltip.add(Text.literal("Number: " + i));
     }
 }
 </code>
-===== Changing ItemStack's BlockEntity data=====
+For versions before 1.20.5, we call ''getBlockEntityNbt'', which internally calls ''getSubNbt''.
-We can change our tooltip to always display some default value even if the stack does not have any BlockEntity data.
+**For versions before 1.20.5:**
-<code java>
+<code java DemoBlock.class>
-public class DemoBlock extends Block implements BlockEntityProvider {
+public class DemoBlock extends BlockWithEntity {
     [...]
@@ Line 78: / Line 122: @@
     public void appendTooltip(ItemStack stack, BlockView world, List<Text> tooltip, TooltipContext context) {
         NbtCompound nbt = BlockItem.getBlockEntityNbt(stack);
-        if (nbt == null){
+        if (nbt == null) return;
-            NbtCompound nbt = new NbtCompound();
-            nbt.putInt("number", 0);
-            BlockItem.setBlockEntityNbt(stack, ExampleMod.DEMO_BLOCK_ENTITY, nbt);
-        }
-        tooltip.add(Text.literal("Number: "+nbt.getInt("number"))
+        tooltip.add(Text.literal("Number: " + nbt.getInt("number"))
     }
 }
 </code>
-===== Placing Block with data =====
+Similarly, you can also modify the ''getName'' method so the data can be displayed directly in the name. In this case, you have to modify how your block item is registered to create ''DemoBlockItem'' instead of ''BlockItem''.
+<code java DemoBlockItem.class>
+public class DemoBlockItem extends BlockItem {
+  public DemoBlockItem(Block block, Settings settings) {
+    super(block, settings);
+  }
-**Is automatic!** As long as the data is in the //"BlockEntityTag"// subNbt (e.g. by using the ''BlockItem.getBlockEntityNbt'' and ''BlockItem.setBlockEntityNbt'' helper methods) under tag keys recognized by the ''readNbt'' method of the ''BlockEntity''.
+  @Override
+  public Text getName(ItemStack stack) {
+    final MutableText name = Text.translatable(stack.getTranslationKey());
+    if (stack.contains(TutorialDataComponentTypes.NUMBER)) {
+      name.append(" - number=" + stack.get(TutorialDataComponentTypes.NUMBER));
+    }
+    return name;
+  }
+}
+</code>
-===== Helpful Reference =====
+===== Pick item with data =====
+In Creative Mode, when you pick item (by pressing the mouse wheel) while holding ''Ctrl'', you can get an item stack with all block entity data. However, if you don't press ''Ctrl'', you can only get one without data, unless you modify ''getPickStack'' method in the ''DemoBlock'' class:
+<code java>
+  @Override
+  public ItemStack getPickStack(WorldView world, BlockPos pos, BlockState state) {
+    final ItemStack pickStack = super.getPickStack(world, pos, state);
+    final BlockEntity blockEntity = world.getBlockEntity(pos);
+    if (blockEntity instanceof DemoBlockEntity demoBlockEntity) {
+      pickStack.applyComponentsFrom(demoBlockEntity.createComponentMap());
+    }
+    return pickStack;
+  }
+</code>
-If something still isn't clear or you want more examples, I highly recommend looking at the Minecraft implementation of ''ShulkerBoxBlock'' and ''ShulkerBoxBlockEntity''. That for example also implements ''Nameable'' interface and has code to **save custom names** through ''ItemStack'' and ''BlockEntity''.
+> **Note:** When ''Ctrl'' is not pressed down, pick-stack happend only on client side. Therefore, you should modify ''toUpdatePacket'' and ''toInitialChunkDataNbt'', and call ''updateListeners'' when modifying data (see [[blockentity modify data#sync data from server to client]]).
-==== Loot Tables ====
+===== Helpful Reference =====
-More info on Loot tables on [[https://minecraft.wiki/w/Loot_table|Minecraft Wiki]].
-Vanilla loot tables: .minecraft\versions\//[version]//\//[version]//.jar\data\minecraft\loot_tables\
+More examples can bee seen in vanilla codes, such as ''ShulkerBoxBlock'' and ''ShulkerBoxBlockEntity'', which implements ''Nameable'' interface and has code to **save custom names** through ''ItemStack'' and ''BlockEntity''. There are also other useful information:
-Also, this [[https://misode.github.io/loot-table/|Loot Table Generator]] might be useful.
+  * [[https://minecraft.wiki/w/Loot_table|Loot table page in Minecraft Wiki]]
+  * [[datagen_loot|Data generation of loot tables]]