Add PlayerClickListener

Mumfrey
1 parent a23a9ea1
Showing 5 changed files with 168 additions and 3 deletions
src/client/java/com/mumfrey/liteloader/client/ClientProxy.java
src/client/java/com/mumfrey/liteloader/client/LiteLoaderEventBrokerClient.java
src/client/java/com/mumfrey/liteloader/client/mixin/MixinMinecraft.java
src/main/java/com/mumfrey/liteloader/PlayerClickListener.java
src/main/java/com/mumfrey/liteloader/PlayerInteractionListener.java
@@ -10,10 +10,12 @@ import java.io.File;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
  
+import com.mumfrey.liteloader.PlayerInteractionListener.MouseButton;
 import com.mumfrey.liteloader.client.ducks.IFramebuffer;
 import com.mumfrey.liteloader.core.Proxy;
  
 import net.minecraft.client.Minecraft;
+import net.minecraft.client.entity.EntityPlayerSP;
 import net.minecraft.client.gui.GuiNewChat;
 import net.minecraft.client.renderer.RenderGlobal;
 import net.minecraft.client.renderer.entity.Render;
@@ -187,4 +189,14 @@ public abstract class ClientProxy extends Proxy
     {
         ClientProxy.broker.onPostRenderEntity(source, entity, x, y, z, yaw, pTicks, render);
     }
+
+    public static boolean onClickMouse(EntityPlayerSP player, MouseButton button)
+    {
+        return ClientProxy.broker.onClickMouse(player, button);
+    }
+
+    public static boolean onMouseHeld(EntityPlayerSP player, MouseButton button)
+    {
+        return ClientProxy.broker.onMouseHeld(player, button);
+    }
 }
@@ -17,6 +17,8 @@ import com.mumfrey.liteloader.HUDRenderListener;
 import com.mumfrey.liteloader.InitCompleteListener;
 import com.mumfrey.liteloader.OutboundChatFilter;
 import com.mumfrey.liteloader.OutboundChatListener;
+import com.mumfrey.liteloader.PlayerClickListener;
+import com.mumfrey.liteloader.PlayerInteractionListener.MouseButton;
 import com.mumfrey.liteloader.PostRenderListener;
 import com.mumfrey.liteloader.PreRenderListener;
 import com.mumfrey.liteloader.RenderListener;
@@ -37,6 +39,7 @@ import com.mumfrey.liteloader.launch.LoaderProperties;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
  
 import net.minecraft.client.Minecraft;
+import net.minecraft.client.entity.EntityPlayerSP;
 import net.minecraft.client.gui.GuiNewChat;
 import net.minecraft.client.gui.ScaledResolution;
 import net.minecraft.client.renderer.RenderGlobal;
@@ -100,6 +103,8 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
     private FastIterableDeque<ScreenshotListener>   screenshotListeners   = new HandlerList<ScreenshotListener>(ScreenshotListener.class,
                                                                                                                 ReturnLogicOp.AND_BREAK_ON_FALSE);
     private FastIterableDeque<EntityRenderListener> entityRenderListeners = new HandlerList<EntityRenderListener>(EntityRenderListener.class);
+    private FastIterableDeque<PlayerClickListener>  playerClickListeners  = new HandlerList<PlayerClickListener>(PlayerClickListener.class,
+                                                                                                                ReturnLogicOp.AND);
  
     @SuppressWarnings("cast")
     public LiteLoaderEventBrokerClient(LiteLoader loader, GameEngineClient engine, LoaderProperties properties)
@@ -146,6 +151,7 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
         delegate.registerInterface(OutboundChatFilter.class);
         delegate.registerInterface(ScreenshotListener.class);
         delegate.registerInterface(EntityRenderListener.class);
+        delegate.registerInterface(PlayerClickListener.class);
     }
  
     /* (non-Javadoc)
@@ -267,6 +273,14 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
     {
         this.entityRenderListeners.add(entityRenderListener);
     }
+    
+    /**
+     * @param playerClickListener
+     */
+    public void addEntityRenderListener(PlayerClickListener playerClickListener)
+    {
+        this.playerClickListeners.add(playerClickListener);
+    }
  
     /**
      * Late initialisation callback
@@ -581,4 +595,14 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
     {
         this.entityRenderListeners.all().onPostRenderEntity(render, entity, xPos, yPos, zPos, yaw, partialTicks);
     }
+
+    public boolean onClickMouse(EntityPlayerSP player, MouseButton button)
+    {
+        return this.playerClickListeners.all().onMouseClicked(player, button);
+    }
+
+    public boolean onMouseHeld(EntityPlayerSP player, MouseButton button)
+    {
+        return this.playerClickListeners.all().onMouseHeld(player, button);
+    }
 }
@@ -16,6 +16,7 @@ import org.spongepowered.asm.mixin.injection.Inject;
 import org.spongepowered.asm.mixin.injection.Redirect;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
  
+import com.mumfrey.liteloader.PlayerInteractionListener.MouseButton;
 import com.mumfrey.liteloader.client.ClientProxy;
 import com.mumfrey.liteloader.client.overlays.IMinecraft;
  
@@ -35,6 +36,9 @@ public abstract class MixinMinecraft implements IMinecraft
     @Shadow private int serverPort;
  
     @Shadow abstract void resize(int width, int height);
+    @Shadow private void clickMouse() {}
+    @Shadow private void rightClickMouse() {}
+    @Shadow private void middleClickMouse() {}
  
     @Inject(method = "startGame()V", at = @At("RETURN"))
     private void onStartupComplete(CallbackInfo ci)
@@ -93,7 +97,7 @@ public abstract class MixinMinecraft implements IMinecraft
         ClientProxy.onTimerUpdate();
     }
  
-    @Inject (method = "runGameLoop()V", at = @At(
+    @Inject(method = "runGameLoop()V", at = @At(
         value = "INVOKE_STRING",
         target = "Lnet/minecraft/profiler/Profiler;endStartSection(Ljava/lang/String;)V",
         args = "ldc=gameRenderer"
@@ -102,6 +106,71 @@ public abstract class MixinMinecraft implements IMinecraft
     {
         ClientProxy.onRender();
     }
+    
+    @Redirect(method = "processKeyBinds()V", at = @At(
+        value = "INVOKE",
+        target = "Lnet/minecraft/client/Minecraft;clickMouse()V"
+    ))
+    private void onClickMouse(Minecraft self)
+    {
+        if (ClientProxy.onClickMouse(self.thePlayer, MouseButton.LEFT))
+        {
+            this.clickMouse();
+        }
+    }
+    
+    @Inject(method = "sendClickBlockToController(Z)V", at = @At(
+            value = "FIELD",
+            target = "Lnet/minecraft/client/Minecraft;objectMouseOver:Lnet/minecraft/util/math/RayTraceResult;",
+            ordinal = 0
+        ),
+        cancellable = true
+    )
+    private void onMouseHeld(boolean leftClick, CallbackInfo ci)
+    {
+        if (!ClientProxy.onMouseHeld(((Minecraft)(Object)this).thePlayer, MouseButton.LEFT))
+        {
+            ci.cancel();
+        }
+    }
+    
+    @Redirect(method = "processKeyBinds()V", at = @At(
+            value = "INVOKE",
+            target = "Lnet/minecraft/client/Minecraft;rightClickMouse()V",
+            ordinal = 0
+    ))
+    private void onRightClickMouse(Minecraft self)
+    {
+        if (ClientProxy.onClickMouse(self.thePlayer, MouseButton.RIGHT))
+        {
+            this.rightClickMouse();
+        }
+    }
+    
+    @Redirect(method = "processKeyBinds()V", at = @At(
+            value = "INVOKE",
+            target = "Lnet/minecraft/client/Minecraft;rightClickMouse()V",
+            ordinal = 1
+    ))
+    private void onRightMouseHeld(Minecraft self)
+    {
+        if (ClientProxy.onMouseHeld(self.thePlayer, MouseButton.RIGHT))
+        {
+            this.rightClickMouse();
+        }
+    }
+    
+    @Redirect(method = "processKeyBinds()V", at = @At(
+            value = "INVOKE",
+            target = "Lnet/minecraft/client/Minecraft;middleClickMouse()V"
+    ))
+    private void onMiddleClickMouse(Minecraft self)
+    {
+        if (ClientProxy.onClickMouse(self.thePlayer, MouseButton.MIDDLE))
+        {
+            this.middleClickMouse();
+        }
+    }
  
     @Override
     public Timer getTimer()
+/*
+ * This file is part of LiteLoader.
+ * Copyright (C) 2012-16 Adam Mummery-Smith
+ * All Rights Reserved.
+ */
+package com.mumfrey.liteloader;
+
+import com.mumfrey.liteloader.PlayerInteractionListener.MouseButton;
+
+import net.minecraft.client.entity.EntityPlayerSP;
+
+/**
+ * Interface for mods which want to listen for and intercept mouse events on the
+ * client side <em>before</em> they trigger remote actions, or otherwise just
+ * be notified that a click is about to be dispatched. 
+ *
+ * @author Adam Mummery-Smith
+ */
+public interface PlayerClickListener extends LiteMod
+{
+    /**
+     * For left, middle and right clicks. Called when the click event is
+     * processed, before any handling has been done. Note that the context of
+     * the click can be obtained from:
+     * 
+     * <ul>
+     *   <li><tt>Minecraft.objectMouseOver</tt> the object currently under
+     *     cursor.</li>
+     *   <li><tt>EntityUtilities.rayTraceFromEntity</tt> using the supplied
+     *     player is useful to determine objects under the cursor at longer
+     *     distances than the player's reach.</li>
+     *   <li><tt>player.isRowingBoat()</tt> is used to inhibit a lot of vanilla
+     *     click behaviour and is worth checking state if acting upon clicks.
+     *   </li>
+     * </ul>
+     * 
+     * @param player The local player
+     * @param button The mouse button which was clicked
+     * @return true to allow the click to be processed normally, false to
+     *      inhibit further processing of the click. Other listeners will still
+     *      be notified.
+     */
+    public abstract boolean onMouseClicked(EntityPlayerSP player, MouseButton button);
+
+    /**
+     * For left and right clicks only, when the player holds the key down the
+     * game periodically processes additional events (eg. mining), this event is
+     * raised after the initial click when the mouse button is held down.
+     * 
+     * @param player The local player
+     * @param button The mouse button being held, only valid for LEFT and RIGHT
+     * @return true to allow the button held event to be processed normally,
+     *      false to inhibit further processing of the click. Other listeners
+     *      will still be notified.
+     */
+    public abstract boolean onMouseHeld(EntityPlayerSP player, MouseButton button);
+}
@@ -14,7 +14,9 @@ import net.minecraft.util.math.RayTraceResult.Type;
  
 /**
  * Interface for mods which want to observe the player's "interaction" status
- * (player mouse clicks), allows block interaction events to be cancelled.
+ * (player mouse clicks), allows block interaction events to be cancelled. This
+ * listener handles clicks on the server side (integrated server in single
+ * player). For client-side interaction events use {@link PlayerClickListener}.
  * 
  * @author Adam Mummery-Smith
  */
@@ -26,7 +28,8 @@ public interface PlayerInteractionListener extends LiteMod
     public static enum MouseButton
     {
         LEFT,
-        RIGHT
+        RIGHT,
+        MIDDLE
     }
  
     /**