Show archeology brushing animations (#3855)

Display items emerging from suspicious blocks

core/src/main/java/org/geysermc/geyser/level/block/BlockStateValues.java

@@ -48,6 +48,7 @@ public final class BlockStateValues {
     private static final IntSet HANGING_SIGNS = new IntOpenHashSet();
     private static final Int2IntMap BANNER_COLORS = new FixedInt2IntMap();
     private static final Int2ByteMap BED_COLORS = new FixedInt2ByteMap();
+    private static final Int2IntMap BRUSH_PROGRESS = new Int2IntOpenHashMap();
     private static final Int2ByteMap COMMAND_BLOCK_VALUES = new Int2ByteOpenHashMap();
     private static final Int2ObjectMap<DoubleChestValue> DOUBLE_CHEST_VALUES = new Int2ObjectOpenHashMap<>();
     private static final Int2ObjectMap<String> FLOWER_POT_VALUES = new Int2ObjectOpenHashMap<>();
@@ -105,6 +106,15 @@ public final class BlockStateValues {
             return;
         }
 
+        JsonNode bedrockStates = blockData.get("bedrock_states");
+        if (bedrockStates != null) {
+            JsonNode brushedProgress = bedrockStates.get("brushed_progress");
+            if (brushedProgress != null) {
+                BRUSH_PROGRESS.put(javaBlockState, brushedProgress.intValue());
+                return;
+            }
+        }
+
         if (javaId.contains("command_block")) {
             COMMAND_BLOCK_VALUES.put(javaBlockState, javaId.contains("conditional=true") ? (byte) 1 : (byte) 0);
             return;
@@ -243,6 +253,17 @@ public final class BlockStateValues {
         return BED_COLORS.getOrDefault(state, (byte) -1);
     }
 
+    /**
+     * The brush progress of suspicious sand/gravel is not sent by the java server when it updates the block entity.
+     * Although brush progress is part of the bedrock block state, it must be included in the block entity update.
+     *
+     * @param state BlockState of the block
+     * @return brush progress or 0 if the lookup failed
+     */
+    public static int getBrushProgress(int state) {
+        return BRUSH_PROGRESS.getOrDefault(state, 0);
+    }
+
     /**
      * Non-water cauldrons (since Bedrock 1.18.30) must have a block entity packet sent on chunk load to fix rendering issues.
      *

core/src/main/java/org/geysermc/geyser/translator/level/block/entity/BrushableBlockEntityTranslator.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.translator.level.block.entity;
+
+import com.github.steveice10.mc.protocol.data.game.level.block.BlockEntityType;
+import com.github.steveice10.opennbt.tag.builtin.CompoundTag;
+import com.github.steveice10.opennbt.tag.builtin.StringTag;
+import com.github.steveice10.opennbt.tag.builtin.Tag;
+import org.cloudburstmc.nbt.NbtMap;
+import org.cloudburstmc.nbt.NbtMapBuilder;
+import org.geysermc.geyser.item.Items;
+import org.geysermc.geyser.level.block.BlockStateValues;
+import org.geysermc.geyser.network.GameProtocol;
+import org.geysermc.geyser.registry.Registries;
+import org.geysermc.geyser.registry.type.ItemMapping;
+
+@BlockEntity(type = BlockEntityType.BRUSHABLE_BLOCK)
+public class BrushableBlockEntityTranslator extends BlockEntityTranslator implements RequiresBlockState {
+
+    @Override
+    public void translateTag(NbtMapBuilder builder, CompoundTag tag, int blockState) {
+        if (!(tag.remove("item") instanceof CompoundTag itemTag)) {
+            return;
+        }
+        Tag hitDirection = tag.get("hit_direction");
+        if (hitDirection == null) {
+            // java server sends no direction when the item recedes back into the block (if player stops brushing)
+            return;
+        }
+
+        String id = ((StringTag) itemTag.get("id")).getValue();
+        if (Items.AIR.javaIdentifier().equals(id)) {
+            return; // server sends air when the block contains nothing
+        }
+
+        ItemMapping mapping = Registries.ITEMS.forVersion(GameProtocol.DEFAULT_BEDROCK_CODEC.getProtocolVersion()).getMapping(id);
+        if (mapping == null) {
+            return;
+        }
+        NbtMapBuilder itemBuilder = NbtMap.builder()
+            .putString("Name", mapping.getBedrockIdentifier())
+            .putByte("Count", (byte) itemTag.get("Count").getValue());
+
+        builder.putCompound("item", itemBuilder.build());
+        // controls which side the item protrudes from
+        builder.putByte("brush_direction", ((Number) hitDirection.getValue()).byteValue());
+        // controls how much the item protrudes
+        builder.putInt("brush_count", BlockStateValues.getBrushProgress(blockState));
+    }
+}