[1.15] Add new InputEvent.ClickInputEvent, addresses #5802 (#6047)

patches/minecraft/net/minecraft/client/Minecraft.java.patch

@@ -162,20 +162,40 @@
        }
  
        this.field_71424_I.func_219897_b();
-@@ -1121,10 +1138,10 @@
+@@ -1121,11 +1138,21 @@
           if (p_147115_1_ && this.field_71476_x != null && this.field_71476_x.func_216346_c() == RayTraceResult.Type.BLOCK) {
              BlockRayTraceResult blockraytraceresult = (BlockRayTraceResult)this.field_71476_x;
              BlockPos blockpos = blockraytraceresult.func_216350_a();
 -            if (!this.field_71441_e.func_180495_p(blockpos).func_196958_f()) {
 +            if (!this.field_71441_e.func_175623_d(blockpos)) {
++               net.minecraftforge.client.event.InputEvent.ClickInputEvent inputEvent = net.minecraftforge.client.ForgeHooksClient.onClickInput(0, this.field_71474_y.field_74312_F, Hand.MAIN_HAND);
++               if (inputEvent.isCanceled()) {
++                  if (inputEvent.shouldSwingHand()) {
++                     this.field_71452_i.addBlockHitEffects(blockpos, blockraytraceresult);
++                     this.field_71439_g.func_184609_a(Hand.MAIN_HAND);
++                  }
++                  return;
++               }
                 Direction direction = blockraytraceresult.func_216354_b();
                 if (this.field_71442_b.func_180512_c(blockpos, direction)) {
 -                  this.field_71452_i.func_180532_a(blockpos, direction);
++                  if (inputEvent.shouldSwingHand()) {
 +                  this.field_71452_i.addBlockHitEffects(blockpos, blockraytraceresult);
                    this.field_71439_g.func_184609_a(Hand.MAIN_HAND);
++                  }
                 }
              }
-@@ -1151,7 +1168,7 @@
+ 
+@@ -1144,6 +1171,8 @@
+             }
+ 
+          } else if (!this.field_71439_g.func_184838_M()) {
++            net.minecraftforge.client.event.InputEvent.ClickInputEvent inputEvent = net.minecraftforge.client.ForgeHooksClient.onClickInput(0, this.field_71474_y.field_74312_F, Hand.MAIN_HAND);
++            if (!inputEvent.isCanceled())
+             switch(this.field_71476_x.func_216346_c()) {
+             case ENTITY:
+                this.field_71442_b.func_78764_a(this.field_71439_g, ((EntityRayTraceResult)this.field_71476_x).func_216348_a());
+@@ -1151,7 +1180,7 @@
              case BLOCK:
                 BlockRayTraceResult blockraytraceresult = (BlockRayTraceResult)this.field_71476_x;
                 BlockPos blockpos = blockraytraceresult.func_216350_a();
@@ -184,15 +204,46 @@
                    this.field_71442_b.func_180511_b(blockpos, blockraytraceresult.func_216354_b());
                    break;
                 }
-@@ -1161,6 +1178,7 @@
+@@ -1161,8 +1190,10 @@
                 }
  
                 this.field_71439_g.func_184821_cY();
 +               net.minecraftforge.common.ForgeHooks.onEmptyLeftClick(this.field_71439_g);
              }
  
++            if (inputEvent.shouldSwingHand())
              this.field_71439_g.func_184609_a(Hand.MAIN_HAND);
-@@ -1217,6 +1235,9 @@
+          }
+       }
+@@ -1177,6 +1208,11 @@
+             }
+ 
+             for(Hand hand : Hand.values()) {
++               net.minecraftforge.client.event.InputEvent.ClickInputEvent inputEvent = net.minecraftforge.client.ForgeHooksClient.onClickInput(1, this.field_71474_y.field_74313_G, hand);
++               if (inputEvent.isCanceled()) {
++                  if (inputEvent.shouldSwingHand()) this.field_71439_g.func_184609_a(hand);
++                  return;
++               }
+                ItemStack itemstack = this.field_71439_g.func_184586_b(hand);
+                if (this.field_71476_x != null) {
+                   switch(this.field_71476_x.func_216346_c()) {
+@@ -1190,6 +1226,7 @@
+ 
+                      if (actionresulttype.func_226246_a_()) {
+                         if (actionresulttype.func_226247_b_()) {
++                           if (inputEvent.shouldSwingHand())
+                            this.field_71439_g.func_184609_a(hand);
+                         }
+ 
+@@ -1202,6 +1239,7 @@
+                      ActionResultType actionresulttype1 = this.field_71442_b.func_217292_a(this.field_71439_g, this.field_71441_e, hand, blockraytraceresult);
+                      if (actionresulttype1.func_226246_a_()) {
+                         if (actionresulttype1.func_226247_b_()) {
++                           if (inputEvent.shouldSwingHand())
+                            this.field_71439_g.func_184609_a(hand);
+                            if (!itemstack.func_190926_b() && (itemstack.func_190916_E() != i || this.field_71442_b.func_78758_h())) {
+                               this.field_71460_t.field_78516_c.func_187460_a(hand);
+@@ -1217,6 +1255,9 @@
                    }
                 }
  
@@ -202,7 +253,7 @@
                 if (!itemstack.func_190926_b()) {
                    ActionResultType actionresulttype2 = this.field_71442_b.func_187101_a(this.field_71439_g, this.field_71441_e, hand);
                    if (actionresulttype2.func_226246_a_()) {
-@@ -1243,6 +1264,8 @@
+@@ -1243,6 +1284,8 @@
           --this.field_71467_ac;
        }
  
@@ -211,7 +262,7 @@
        this.field_71424_I.func_76320_a("gui");
        if (!this.field_71445_n) {
           this.field_71456_v.func_73831_a();
-@@ -1360,6 +1383,8 @@
+@@ -1360,6 +1403,8 @@
        this.field_71424_I.func_219895_b("keyboard");
        this.field_195559_v.func_204870_b();
        this.field_71424_I.func_76319_b();
@@ -220,7 +271,7 @@
     }
  
     private void func_184117_aA() {
-@@ -1514,6 +1539,12 @@
+@@ -1514,6 +1559,12 @@
        this.func_147108_a(worldloadprogressscreen);
  
        while(!this.field_71437_Z.func_71200_ad()) {
@@ -233,7 +284,7 @@
           worldloadprogressscreen.tick();
           this.func_195542_b(false);
  
-@@ -1534,11 +1565,17 @@
+@@ -1534,11 +1585,17 @@
        networkmanager.func_150719_a(new ClientLoginNetHandler(networkmanager, this, (Screen)null, (p_229998_0_) -> {
        }));
        networkmanager.func_179290_a(new CHandshakePacket(socketaddress.toString(), 0, ProtocolType.LOGIN));
@@ -252,7 +303,7 @@
        WorkingScreen workingscreen = new WorkingScreen();
        workingscreen.func_200210_a(new TranslationTextComponent("connect.joining"));
        this.func_213241_c(workingscreen);
-@@ -1570,10 +1607,12 @@
+@@ -1570,10 +1627,12 @@
        IntegratedServer integratedserver = this.field_71437_Z;
        this.field_71437_Z = null;
        this.field_71460_t.func_190564_k();
@@ -265,7 +316,7 @@
           if (integratedserver != null) {
              while(!integratedserver.func_213201_w()) {
                 this.func_195542_b(false);
-@@ -1605,6 +1644,7 @@
+@@ -1605,6 +1664,7 @@
        this.field_71438_f.func_72732_a(p_213257_1_);
        this.field_71452_i.func_78870_a(p_213257_1_);
        TileEntityRendererDispatcher.field_147556_a.func_147543_a(p_213257_1_);
@@ -273,7 +324,7 @@
     }
  
     public final boolean func_71355_q() {
-@@ -1630,112 +1670,8 @@
+@@ -1630,112 +1690,9 @@
  
     private void func_147112_ai() {
        if (this.field_71476_x != null && this.field_71476_x.func_216346_c() != RayTraceResult.Type.MISS) {
@@ -383,12 +434,13 @@
 -            }
 -
 -         }
++         if (!net.minecraftforge.client.ForgeHooksClient.onClickInput(2, this.field_71474_y.field_74322_I, Hand.MAIN_HAND).isCanceled())
 +         net.minecraftforge.common.ForgeHooks.onPickBlock(this.field_71476_x, this.field_71439_g, this.field_71441_e);
 +         // We delete this code wholly instead of commenting it out, to make sure we detect changes in it between MC versions
        }
     }
  
-@@ -1817,6 +1753,7 @@
+@@ -1817,6 +1774,7 @@
        return field_71432_P;
     }
  
@@ -396,7 +448,7 @@
     public CompletableFuture<Void> func_213245_w() {
        return this.func_213169_a(this::func_213237_g).thenCompose((p_229993_0_) -> {
           return p_229993_0_;
-@@ -1944,6 +1881,8 @@
+@@ -1944,6 +1902,8 @@
     }
  
     public MusicTicker.MusicType func_147109_W() {
@@ -405,7 +457,7 @@
        if (this.field_71462_r instanceof WinGameScreen) {
           return MusicTicker.MusicType.CREDITS;
        } else if (this.field_71439_g == null) {
-@@ -2120,7 +2059,7 @@
+@@ -2120,7 +2080,7 @@
           supplier = func_228022_c_(supplier);
        }
  
@@ -414,7 +466,7 @@
     }
  
     private static Supplier<IResourcePack> func_228021_b_(Supplier<IResourcePack> p_228021_0_) {
-@@ -2138,4 +2077,12 @@
+@@ -2138,4 +2098,12 @@
     public void func_228020_b_(int p_228020_1_) {
        this.field_175617_aL.func_229355_a_(p_228020_1_);
     }

src/main/java/net/minecraftforge/client/ForgeHooksClient.java

@@ -51,6 +51,7 @@ import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 
 import net.minecraft.client.renderer.*;
+import net.minecraft.client.settings.KeyBinding;
 import net.minecraftforge.client.model.pipeline.LightUtil;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -962,4 +963,11 @@ public class ForgeHooksClient
     {
         return MinecraftForge.EVENT_BUS.post(new InputEvent.RawMouseEvent(button, action, mods));
     }
+
+    public static InputEvent.ClickInputEvent onClickInput(int button, KeyBinding keyBinding, Hand hand)
+    {
+        InputEvent.ClickInputEvent event = new InputEvent.ClickInputEvent(button, keyBinding, hand);
+        MinecraftForge.EVENT_BUS.post(event);
+        return event;
+    }
 }

src/main/java/net/minecraftforge/client/event/InputEvent.java

@@ -19,7 +19,9 @@
 
 package net.minecraftforge.client.event;
 
+import net.minecraft.client.settings.KeyBinding;
 import net.minecraft.client.util.InputMappings;
+import net.minecraft.util.Hand;
 import net.minecraftforge.eventbus.api.Cancelable;
 import net.minecraftforge.eventbus.api.Event;
 
@@ -253,4 +255,71 @@ public class InputEvent extends Event
             return this.modifiers;
         }
     }
+
+    /**
+     * This event fires when one of the keybindings that by default involves clicking the mouse buttons
+     * is triggered.
+     *
+     * These key bindings are use item, pick block and attack keybindings. (right, middle and left mouse click)
+     * In the case that these key bindings are re-bound to a keyboard key the event will still be fired as normal.
+     */
+    @Cancelable
+    public static class ClickInputEvent extends InputEvent
+    {
+        private final int button;
+        private final KeyBinding keyBinding;
+        private final Hand hand;
+        private boolean handSwing = true;
+        public ClickInputEvent(int button, KeyBinding keyBinding, Hand hand)
+        {
+            this.button = button;
+            this.keyBinding = keyBinding;
+            this.hand = hand;
+        }
+
+        /**
+         * Set to false to disable the hand swing animation.
+         * Has no effect if this is a pick block input.
+         */
+        public void setSwingHand(boolean value)
+        {
+            handSwing = value;
+        }
+
+        public boolean shouldSwingHand()
+        {
+            return handSwing;
+        }
+
+        /**
+         * The hand which is causing the event to get triggered.
+         * The event will be called for both hands if this is a use item input regardless
+         * of if either gets canceled.
+         * Will always be MAIN_HAND if this is an attack or pick block input.
+         */
+        public Hand getHand()
+        {
+            return hand;
+        }
+
+        public boolean isAttack()
+        {
+            return button == 0;
+        }
+
+        public boolean isUseItem()
+        {
+            return button == 1;
+        }
+
+        public boolean isPickBlock()
+        {
+            return button == 2;
+        }
+
+        public KeyBinding getKeyBinding()
+        {
+            return keyBinding;
+        }
+    }
 }