cleanup keybind code (#2745)

Author: TechLord22

src/main/java/gregtech/api/util/input/KeyBind.java

@@ -2,7 +2,6 @@
 
 import gregtech.api.GTValues;
 import gregtech.api.GregTechAPI;
-import gregtech.api.util.GTLog;
 import gregtech.core.network.packets.PacketKeysPressed;
 
 import net.minecraft.client.Minecraft;
@@ -11,20 +10,21 @@
 import net.minecraft.entity.player.EntityPlayerMP;
 import net.minecraftforge.client.settings.IKeyConflictContext;
 import net.minecraftforge.client.settings.KeyConflictContext;
-import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.fml.client.registry.ClientRegistry;
 import net.minecraftforge.fml.common.FMLCommonHandler;
 import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
 import net.minecraftforge.fml.common.gameevent.InputEvent;
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
 
-import org.apache.commons.lang3.tuple.MutablePair;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
 import org.lwjgl.input.Keyboard;
 import org.lwjgl.input.Mouse;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.WeakHashMap;
 import java.util.function.Supplier;
 
@@ -43,13 +43,6 @@ public enum KeyBind {
 
     public static final KeyBind[] VALUES = values();
 
-    public static void init() {
-        GTLog.logger.info("Registering KeyBinds");
-        if (FMLCommonHandler.instance().getSide().isClient()) {
-            MinecraftForge.EVENT_BUS.register(KeyBind.class);
-        }
-    }
-
     @SubscribeEvent
     @SideOnly(Side.CLIENT)
     public static void onInputEvent(InputEvent.KeyInputEvent event) {
@@ -83,75 +76,89 @@ public static boolean scrollingDown() {
         return Mouse.getEventDWheel() < 0;
     }
 
+    private final Map<EntityPlayerMP, Boolean> keysPressed = new WeakHashMap<>();
+    private final Map<EntityPlayerMP, Boolean> keysDown = new WeakHashMap<>();
+
     @SideOnly(Side.CLIENT)
-    private KeyBinding keybinding;
+    private KeyBinding mcKeyBinding;
     @SideOnly(Side.CLIENT)
-    private boolean isPressed, isKeyDown;
-
-    private final WeakHashMap<EntityPlayerMP, MutablePair<Boolean, Boolean>> mapping = new WeakHashMap<>();
-
-    // For Vanilla/Other Mod keybinds
-    // Double Supplier to keep client classes from loading
-    KeyBind(Supplier<Supplier<KeyBinding>> keybindingGetter) {
+    private boolean isPressed;
+    @SideOnly(Side.CLIENT)
+    private boolean isKeyDown;
+
+    /**
+     * For Vanilla/Other Mod keybinds
+     * <p>
+     * Double Supplier keeps client classes from loading
+     *
+     * @param keybindingSupplier supplier to the client side keybinding
+     */
+    KeyBind(@NotNull Supplier<Supplier<KeyBinding>> keybindingSupplier) {
         if (FMLCommonHandler.instance().getSide().isClient()) {
-            this.keybinding = keybindingGetter.get().get();
+            this.mcKeyBinding = keybindingSupplier.get().get();
         }
     }
 
-    KeyBind(String langKey, int button) {
+    KeyBind(@NotNull String langKey, int button) {
         if (FMLCommonHandler.instance().getSide().isClient()) {
-            this.keybinding = new KeyBinding(langKey, button, GTValues.MOD_NAME);
-            ClientRegistry.registerKeyBinding(this.keybinding);
+            this.mcKeyBinding = new KeyBinding(langKey, button, GTValues.MOD_NAME);
+            ClientRegistry.registerKeyBinding(this.mcKeyBinding);
         }
     }
 
-    KeyBind(String langKey, IKeyConflictContext ctx, int button) {
+    KeyBind(@NotNull String langKey, @NotNull IKeyConflictContext ctx, int button) {
         if (FMLCommonHandler.instance().getSide().isClient()) {
-            this.keybinding = new KeyBinding(langKey, ctx, button, GTValues.MOD_NAME);
-            ClientRegistry.registerKeyBinding(this.keybinding);
+            this.mcKeyBinding = new KeyBinding(langKey, ctx, button, GTValues.MOD_NAME);
+            ClientRegistry.registerKeyBinding(this.mcKeyBinding);
         }
     }
 
     @SideOnly(Side.CLIENT)
     public KeyBinding toMinecraft() {
-        return this.keybinding;
+        return this.mcKeyBinding;
     }
 
     @SideOnly(Side.CLIENT)
     public boolean isPressed() {
-        return this.keybinding.isPressed();
+        return this.mcKeyBinding.isPressed();
     }
 
     @SideOnly(Side.CLIENT)
     public boolean isKeyDown() {
-        return this.keybinding.isKeyDown();
+        return this.mcKeyBinding.isKeyDown();
     }
 
-    public void update(boolean pressed, boolean keyDown, EntityPlayerMP player) {
-        MutablePair<Boolean, Boolean> pair = this.mapping.get(player);
-        if (pair == null) {
-            this.mapping.put(player, MutablePair.of(pressed, keyDown));
-        } else {
-            pair.left = pressed;
-            pair.right = keyDown;
-        }
+    @ApiStatus.Internal
+    public void updateServerState(@NotNull EntityPlayerMP player, boolean pressed, boolean keyDown) {
+        this.keysPressed.put(player, pressed);
+        this.keysDown.put(player, keyDown);
     }
 
-    public boolean isPressed(EntityPlayer player) {
+    /**
+     * Can call on either the {@code Server} or {@code Client} side.
+     *
+     * @param player the player to test
+     * @return if the player pressed the key
+     */
+    public boolean isPressed(@NotNull EntityPlayer player) {
         if (player.world.isRemote) {
             return isPressed();
         } else {
-            MutablePair<Boolean, Boolean> pair = this.mapping.get((EntityPlayerMP) player);
-            return pair != null && pair.left;
+            return keysPressed.getOrDefault((EntityPlayerMP) player, false);
         }
     }
 
-    public boolean isKeyDown(EntityPlayer player) {
+    /**
+     * Can call on either the {@code Server} or {@code Client} side.
+     *
+     * @param player the player to test
+     * @return if the player is holding the key down
+     */
+    public boolean isKeyDown(@NotNull EntityPlayer player) {
         if (player.world.isRemote) {
             return isKeyDown();
         } else {
-            MutablePair<Boolean, Boolean> pair = this.mapping.get((EntityPlayerMP) player);
-            return pair != null && pair.right;
+            return keysDown.getOrDefault((EntityPlayerMP) player, false);
         }
     }
 }

src/main/java/gregtech/client/ClientProxy.java

@@ -12,6 +12,7 @@
 import gregtech.api.util.GTLog;
 import gregtech.api.util.IBlockOre;
 import gregtech.api.util.Mods;
+import gregtech.api.util.input.KeyBind;
 import gregtech.client.model.customtexture.CustomTextureModelHandler;
 import gregtech.client.model.customtexture.MetadataSectionCTM;
 import gregtech.client.renderer.handler.FacadeRenderer;
@@ -105,6 +106,8 @@ public void onPreLoad() {
         OpticalPipeRenderer.INSTANCE.preInit();
         LaserPipeRenderer.INSTANCE.preInit();
         MetaEntities.initRenderers();
+
+        MinecraftForge.EVENT_BUS.register(KeyBind.class);
     }
 
     @Override

src/main/java/gregtech/core/CoreModule.java

@@ -29,7 +29,6 @@
 import gregtech.api.unification.material.registry.MarkerMaterialRegistry;
 import gregtech.api.util.CapesRegistry;
 import gregtech.api.util.Mods;
-import gregtech.api.util.input.KeyBind;
 import gregtech.api.util.oreglob.OreGlob;
 import gregtech.api.util.virtualregistry.VirtualEnderRegistry;
 import gregtech.api.worldgen.bedrockFluids.BedrockFluidVeinHandler;
@@ -228,7 +227,6 @@ public void preInit(FMLPreInitializationEvent event) {
         /* End API Block Registration */
 
         proxy.onPreLoad();
-        KeyBind.init();
     }
 
     @Override

src/main/java/gregtech/core/network/packets/PacketKeysPressed.java

@@ -7,51 +7,55 @@
 import net.minecraft.network.NetHandlerPlayServer;
 import net.minecraft.network.PacketBuffer;
 
-import org.apache.commons.lang3.tuple.Pair;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.List;
 
 public class PacketKeysPressed implements IPacket, IServerExecutor {
 
-    private Object updateKeys;
+    private List<KeyBind> clientKeysUpdated;
+    private int[] serverKeysUpdated;
+    private boolean[] serverKeysPressed;
+    private boolean[] serverKeysDown;
 
     @SuppressWarnings("unused")
     public PacketKeysPressed() {}
 
-    public PacketKeysPressed(List<KeyBind> updateKeys) {
-        this.updateKeys = updateKeys;
+    public PacketKeysPressed(@NotNull List<KeyBind> clientKeysUpdated) {
+        this.clientKeysUpdated = clientKeysUpdated;
     }
 
     @Override
-    public void encode(PacketBuffer buf) {
-        List<KeyBind> updateKeys = (List<KeyBind>) this.updateKeys;
-        buf.writeVarInt(updateKeys.size());
-        for (KeyBind keyBind : updateKeys) {
-            buf.writeVarInt(keyBind.ordinal());
+    public void encode(@NotNull PacketBuffer buf) {
+        buf.writeVarInt(clientKeysUpdated.size());
+        for (KeyBind keyBind : clientKeysUpdated) {
+            buf.writeByte(keyBind.ordinal());
             buf.writeBoolean(keyBind.isPressed());
             buf.writeBoolean(keyBind.isKeyDown());
         }
     }
 
     @Override
-    public void decode(PacketBuffer buf) {
-        this.updateKeys = new Pair[KeyBind.VALUES.length];
-        Pair<Boolean, Boolean>[] updateKeys = (Pair<Boolean, Boolean>[]) this.updateKeys;
-        int size = buf.readVarInt();
+    public void decode(@NotNull PacketBuffer buf) {
+        final int size = buf.readVarInt();
+        this.serverKeysUpdated = new int[size];
+        this.serverKeysPressed = new boolean[size];
+        this.serverKeysDown = new boolean[size];
         for (int i = 0; i < size; i++) {
-            updateKeys[buf.readVarInt()] = Pair.of(buf.readBoolean(), buf.readBoolean());
+            serverKeysUpdated[i] = buf.readByte();
+            serverKeysPressed[i] = buf.readBoolean();
+            serverKeysDown[i] = buf.readBoolean();
         }
     }
 
     @Override
     public void executeServer(NetHandlerPlayServer handler) {
-        KeyBind[] keybinds = KeyBind.VALUES;
-        Pair<Boolean, Boolean>[] updateKeys = (Pair<Boolean, Boolean>[]) this.updateKeys;
-        for (int i = 0; i < updateKeys.length; i++) {
-            Pair<Boolean, Boolean> pair = updateKeys[i];
-            if (pair != null) {
-                keybinds[i].update(pair.getLeft(), pair.getRight(), handler.player);
-            }
+        if (serverKeysUpdated == null) {
+            throw new IllegalStateException("PacketKeysPressed called executeServer() before decode()");
+        }
+
+        for (int i = 0; i < serverKeysUpdated.length; i++) {
+            KeyBind.VALUES[i].updateServerState(handler.player, serverKeysPressed[i], serverKeysDown[i]);
         }
     }
 }