Implement beacon

connector/src/main/java/org/geysermc/connector/inventory/BeaconContainer.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2019-2020 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.connector.inventory;
+
+import com.github.steveice10.mc.protocol.data.game.window.WindowType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class BeaconContainer extends Container {
+    private int primaryId;
+    private int secondaryId;
+
+    public BeaconContainer(String title, int id, WindowType windowType, int size, PlayerInventory playerInventory) {
+        super(title, id, windowType, size, playerInventory);
+    }
+}

connector/src/main/java/org/geysermc/connector/inventory/Inventory.java

@@ -50,6 +50,9 @@ public class Inventory {
 
     protected GeyserItemStack[] items;
 
+    /**
+     * The location of the inventory block. Will either be a fake block above the player's head, or the actual block location
+     */
     @Getter
     @Setter
     protected Vector3i holderPosition = Vector3i.ZERO;

connector/src/main/java/org/geysermc/connector/network/translators/inventory/InventoryTranslator.java

@@ -80,6 +80,7 @@ public abstract class InventoryTranslator {
 
             /* Specific Inventories */
             put(WindowType.ANVIL, new AnvilInventoryTranslator());
+            put(WindowType.BEACON, new BeaconInventoryTranslator());
             put(WindowType.BREWING_STAND, new BrewingInventoryTranslator());
             put(WindowType.CRAFTING, new CraftingInventoryTranslator());
             put(WindowType.ENCHANTMENT, new EnchantingInventoryTranslator());
@@ -91,7 +92,6 @@ public abstract class InventoryTranslator {
             /* Generics */
             put(WindowType.GENERIC_3X3, new GenericBlockInventoryTranslator(9, "minecraft:dispenser[facing=north,triggered=false]", ContainerType.DISPENSER));
             put(WindowType.HOPPER, new GenericBlockInventoryTranslator(5, "minecraft:hopper[enabled=false,facing=down]", ContainerType.HOPPER));
-            //put(WindowType.BEACON, new AbstractBlockInventoryTranslator(1, "minecraft:beacon", ContainerType.BEACON)); //TODO
 
             //put(WindowType.CARTOGRAPHY
             //put(WindowType.STONECUTTER

connector/src/main/java/org/geysermc/connector/network/translators/inventory/holder/BlockInventoryHolder.java

@@ -48,6 +48,11 @@ public class BlockInventoryHolder extends InventoryHolder {
 
     @Override
     public void prepareInventory(InventoryTranslator translator, GeyserSession session, Inventory inventory) {
+        //TODO: Improve on this (for example, multiple block states). We need this for the beacon.
+        if (BlockTranslator.getBedrockBlockId(session.getConnector().getWorldManager().getBlockAt(session, session.getLastInteractionPosition())) == blockId) {
+            inventory.setHolderPosition(session.getLastInteractionPosition());
+            return;
+        }
         Vector3i position = session.getPlayerEntity().getPosition().toInt();
         position = position.add(Vector3i.UP);
         UpdateBlockPacket blockPacket = new UpdateBlockPacket();
@@ -82,6 +87,9 @@ public class BlockInventoryHolder extends InventoryHolder {
     @Override
     public void closeInventory(InventoryTranslator translator, GeyserSession session, Inventory inventory) {
         Vector3i holderPos = inventory.getHolderPosition();
+        if (holderPos.equals(session.getLastInteractionPosition())) {
+            return;
+        }
         Position pos = new Position(holderPos.getX(), holderPos.getY(), holderPos.getZ());
         int realBlock = session.getConnector().getWorldManager().getBlockAt(session, pos.getX(), pos.getY(), pos.getZ());
         UpdateBlockPacket blockPacket = new UpdateBlockPacket();

connector/src/main/java/org/geysermc/connector/network/translators/inventory/translators/BeaconInventoryTranslator.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2019-2020 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.connector.network.translators.inventory.translators;
+
+import com.github.steveice10.mc.protocol.data.game.window.WindowType;
+import com.github.steveice10.mc.protocol.packet.ingame.client.window.ClientSetBeaconEffectPacket;
+import com.nukkitx.math.vector.Vector3i;
+import com.nukkitx.nbt.NbtMap;
+import com.nukkitx.nbt.NbtMapBuilder;
+import com.nukkitx.protocol.bedrock.data.inventory.ContainerSlotType;
+import com.nukkitx.protocol.bedrock.data.inventory.ContainerType;
+import com.nukkitx.protocol.bedrock.data.inventory.StackRequestSlotInfoData;
+import com.nukkitx.protocol.bedrock.data.inventory.stackrequestactions.BeaconPaymentStackRequestActionData;
+import com.nukkitx.protocol.bedrock.data.inventory.stackrequestactions.StackRequestActionData;
+import com.nukkitx.protocol.bedrock.data.inventory.stackrequestactions.StackRequestActionType;
+import com.nukkitx.protocol.bedrock.packet.BlockEntityDataPacket;
+import com.nukkitx.protocol.bedrock.packet.ItemStackRequestPacket;
+import com.nukkitx.protocol.bedrock.packet.ItemStackResponsePacket;
+import org.geysermc.connector.inventory.BeaconContainer;
+import org.geysermc.connector.inventory.Inventory;
+import org.geysermc.connector.inventory.PlayerInventory;
+import org.geysermc.connector.network.session.GeyserSession;
+import org.geysermc.connector.network.translators.inventory.BedrockContainerSlot;
+import org.geysermc.connector.network.translators.inventory.updater.UIInventoryUpdater;
+
+import java.util.Collections;
+
+public class BeaconInventoryTranslator extends AbstractBlockInventoryTranslator {
+    public BeaconInventoryTranslator() {
+        super(1, "minecraft:beacon", ContainerType.BEACON, UIInventoryUpdater.INSTANCE);
+    }
+
+    @Override
+    public void updateProperty(GeyserSession session, Inventory inventory, int key, int value) {
+        //FIXME?: Beacon graphics look weird after inputting an item. This might be a Bedrock bug, since it resets to nothing
+        // on BDS
+        BeaconContainer beaconContainer = (BeaconContainer) inventory;
+        switch (key) {
+            case 0:
+                // Power - beacon doesn't use this, and uses the block position instead
+                break;
+            case 1:
+                beaconContainer.setPrimaryId(value == -1 ? 0 : value);
+                break;
+            case 2:
+                beaconContainer.setSecondaryId(value == -1 ? 0 : value);
+                break;
+        }
+
+        // Send a block entity data packet update to the fake beacon inventory
+        Vector3i position = inventory.getHolderPosition();
+        NbtMapBuilder builder = NbtMap.builder()
+                .putInt("x", position.getX())
+                .putInt("y", position.getY())
+                .putInt("z", position.getZ())
+                .putString("CustomName", inventory.getTitle())
+                .putString("id", "Beacon")
+                .putInt("primary", beaconContainer.getPrimaryId())
+                .putInt("secondary", beaconContainer.getSecondaryId());
+
+        BlockEntityDataPacket packet = new BlockEntityDataPacket();
+        packet.setBlockPosition(position);
+        packet.setData(builder.build());
+        System.out.println(packet.toString());
+        session.sendUpstreamPacket(packet);
+    }
+
+    @Override
+    public boolean shouldHandleRequestFirst(StackRequestActionData action) {
+        return action.getType() == StackRequestActionType.BEACON_PAYMENT;
+    }
+
+    @Override
+    public ItemStackResponsePacket.Response translateSpecialRequest(GeyserSession session, Inventory inventory, ItemStackRequestPacket.Request request) {
+        // Input a beacon payment
+        BeaconPaymentStackRequestActionData beaconPayment = (BeaconPaymentStackRequestActionData) request.getActions()[0];
+        ClientSetBeaconEffectPacket packet = new ClientSetBeaconEffectPacket(beaconPayment.getPrimaryEffect(), beaconPayment.getSecondaryEffect());
+        System.out.println(packet.toString());
+        session.sendDownstreamPacket(packet);
+        return acceptRequest(request, makeContainerEntries(session, inventory, Collections.emptySet()));
+    }
+
+    @Override
+    public int bedrockSlotToJava(StackRequestSlotInfoData slotInfoData) {
+        if (slotInfoData.getContainer() == ContainerSlotType.BEACON_PAYMENT) {
+            return 0;
+        }
+        return super.bedrockSlotToJava(slotInfoData);
+    }
+
+    @Override
+    public BedrockContainerSlot javaSlotToBedrockContainer(int slot) {
+        if (slot == 0) {
+            return new BedrockContainerSlot(ContainerSlotType.BEACON_PAYMENT, 27);
+        }
+        return super.javaSlotToBedrockContainer(slot);
+    }
+
+    @Override
+    public int javaSlotToBedrock(int slot) {
+        if (slot == 0) {
+            return 27;
+        }
+        return super.javaSlotToBedrock(slot);
+    }
+
+    @Override
+    public Inventory createInventory(String name, int windowId, WindowType windowType, PlayerInventory playerInventory) {
+        return new BeaconContainer(name, windowId, windowType, this.size, playerInventory);
+    }
+}

connector/src/main/java/org/geysermc/connector/network/translators/world/block/entity/BeaconBlockEntityTranslator.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2019-2020 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.connector.network.translators.world.block.entity;
+
+import com.github.steveice10.opennbt.tag.builtin.CompoundTag;
+import com.nukkitx.nbt.NbtMapBuilder;
+
+@BlockEntity(name = "Beacon", regex = "beacon")
+public class BeaconBlockEntityTranslator extends BlockEntityTranslator {
+    @Override
+    public void translateTag(NbtMapBuilder builder, CompoundTag tag, int blockState) {
+        int primary = getOrDefault(tag.get("Primary"), 0);
+        // The effects here generally map one-to-one Java <-> Bedrock. Only the newer ones get more complicated
+        builder.putInt("primary", primary == -1 ? 0 : primary);
+        int secondary = getOrDefault(tag.get("Secondary"), 0);
+        builder.putInt("secondary", secondary == -1 ? 0 : secondary);
+    }
+}