feat(handler): Added a Hit handler.

Author: Shuvlyy

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HashGuiHit.java

@@ -0,0 +1,75 @@
+package fr.hashtek.spigot.hashgui.handler.hit;
+
+import fr.hashtek.spigot.hashitem.HashItem;
+import org.bukkit.inventory.meta.ItemMeta;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+public class HashGuiHit
+{
+	
+	private final HashMap<String, ArrayList<HitHandler>> hitHandlers;
+	
+	
+	/**
+	 * Creates a new instance of HashGUIInteraction.
+	 */
+	public HashGuiHit()
+	{
+		this.hitHandlers = new HashMap<String, ArrayList<HitHandler>>();
+	}
+
+
+	/**
+	 * Adds a hit handler for a certain title.
+	 * 
+	 * @param	title	Title
+	 * @param	handler	Interaction handler
+	 * @return	Returns itself.
+	 */
+	private HashGuiHit addHitHandler(String title, HitHandler handler)
+	{
+        this.hitHandlers.computeIfAbsent(title, k -> new ArrayList<HitHandler>());
+
+		for (HitHandler h : this.hitHandlers.get(title))
+			if (handler.equals(h))
+				return this;
+
+		this.hitHandlers.get(title).add(handler);
+		return this;
+	}
+
+	/**
+	 * Adds a hit handler for an item.
+	 * 
+	 * @param	item	Item
+	 * @return	Returns itself.
+	 */
+	public HashGuiHit addHitHandler(HashItem item)
+	{
+		List<HitHandler> hitHandlers = item.getHitHandlers();
+		
+		if (hitHandlers == null || hitHandlers.isEmpty())
+			return this;
+		
+		final ItemMeta meta = item.getItemStack().getItemMeta();
+		final String itemName = meta.getDisplayName();
+		
+		for (HitHandler handler: item.getHitHandlers())
+			this.addHitHandler(itemName, handler);
+		
+		return this;
+	}
+
+
+	/**
+	 * @return	Registered interact handlers
+	 */
+	public HashMap<String, ArrayList<HitHandler>> getHitHandlers()
+	{
+		return this.hitHandlers;
+	}
+
+}

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HitAction.java

@@ -0,0 +1,22 @@
+package fr.hashtek.spigot.hashgui.handler.hit;
+
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+
+public interface HitAction
+{
+
+	/**
+	 * Function called when item is used in a hit.
+	 * 
+	 * @param	attacker	Player who hit
+	 * @param	victim	Player who got hit
+	 * @param	item	Used item
+	 */
+    void execute(
+		Player attacker,
+		Player victim,
+		ItemStack item
+    );
+	
+}

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HitHandler.java

@@ -0,0 +1,72 @@
+package fr.hashtek.spigot.hashgui.handler.hit;
+
+public class HitHandler
+{
+
+	private HitAction hitAction;
+	private boolean isOnlyKill;
+
+
+	/**
+	 * Creates an empty instance of InteractHandler.
+	 */
+	public HitHandler()
+	{
+		this.isOnlyKill = false;
+	}
+
+
+	/**
+	 * Makes that the action is fired only when the hit results
+	 * in a kill. Or not.
+	 *
+	 * @param	isOnlyKill	Only kill
+	 * @return	Returns itself.
+	 */
+	public HitHandler setOnlyKill(boolean isOnlyKill)
+	{
+		this.isOnlyKill = isOnlyKill;
+		return this;
+	}
+
+	/**
+	 * Sets handler's hit action. (on hit, then do...)
+	 * 
+	 * @param	hitAction	Interact action
+	 * @return	Returns itself.
+	 */
+	public HitHandler setHitAction(HitAction hitAction)
+	{
+		this.hitAction = hitAction;
+		return this;
+	}
+
+	/**
+	 * @param	handler	Handler to compare
+	 * @return	Returns true if both handlers contains the same instructions
+	 */
+	public boolean equals(HitHandler handler)
+	{
+		return
+			this.hitAction.equals(handler.hitAction) &&
+			this.isOnlyKill == handler.isOnlyKill();
+	}
+
+
+	/**
+	 * @return	True if the handler fired only when the hit results in a kill
+	 */
+	public boolean isOnlyKill()
+	{
+		return this.isOnlyKill;
+	}
+
+	/**
+	 * @return	Assigned action
+	 */
+	public HitAction getHitAction()
+	{
+		return this.hitAction;
+	}
+	
+}

src/main/java/fr/hashtek/spigot/hashgui/listener/HashGuiHitListener.java

@@ -0,0 +1,81 @@
+package fr.hashtek.spigot.hashgui.listener;
+
+import fr.hashtek.spigot.hashgui.handler.hit.HashGuiHit;
+import fr.hashtek.spigot.hashgui.handler.hit.HitHandler;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.event.entity.EntityDamageByEntityEvent;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+
+import java.util.ArrayList;
+
+public class HashGuiHitListener implements Listener
+{
+
+    private final HashGuiHit hitManager;
+
+
+    /**
+     * Creates a new instance of HashGuiKillListener, with
+     * a kill manager for kill handling.
+     *
+     * @param	hitManager Hit manager
+     */
+    public HashGuiHitListener(HashGuiHit hitManager)
+    {
+        this.hitManager = hitManager;
+    }
+
+
+    /**
+     * Executes the kill actions linked to the used item.
+     *
+     * @param	attacker	Player who hit
+     * @param	victim		Player who got hit
+     * @param	item        Used item
+     */
+    private void processHit(
+        Player attacker,
+        Player victim,
+        ItemStack item,
+        boolean isKill
+    )
+    {
+        final ItemMeta meta = item.getItemMeta();
+        final String itemDisplayName = meta.getDisplayName();
+        final ArrayList<HitHandler> hitHandlers = this.hitManager.getHitHandlers().get(itemDisplayName);
+
+        if (hitHandlers == null || hitHandlers.isEmpty())
+            return;
+
+        hitHandlers.stream()
+            .filter((HitHandler hitHandler) ->
+                isKill == hitHandler.isOnlyKill())
+            .forEach((HitHandler handler) ->
+                handler.getHitAction().execute(attacker, victim, item));
+    }
+
+    /**
+     * Hit handling
+     */
+    @EventHandler
+    public void onInteract(EntityDamageByEntityEvent event)
+    {
+        if (!(event.getDamager() instanceof Player && event.getEntity() instanceof Player))
+            return;
+
+        final Player attacker = (Player) event.getDamager();
+        final Player victim = (Player) event.getEntity();
+        final ItemStack itemUsed = attacker.getInventory().getItemInHand();
+
+        this.processHit(
+            attacker,
+            victim,
+            itemUsed,
+            victim.getHealth() - event.getFinalDamage() <= 0
+        );
+    }
+
+}

src/main/java/fr/hashtek/spigot/hashgui/manager/HashGuiManager.java

@@ -1,7 +1,9 @@
 package fr.hashtek.spigot.hashgui.manager;
 
 import fr.hashtek.spigot.hashgui.handler.hold.HashGuiHold;
+import fr.hashtek.spigot.hashgui.handler.hit.HashGuiHit;
 import fr.hashtek.spigot.hashgui.listener.HashGuiHoldListener;
+import fr.hashtek.spigot.hashgui.listener.HashGuiHitListener;
 import org.bukkit.plugin.PluginManager;
 import org.bukkit.plugin.java.JavaPlugin;
 
@@ -19,6 +21,7 @@ public class HashGuiManager
 	private HashGuiClick clickManager;
 	private HashGuiInteraction interactionManager;
 	private HashGuiHold holdManager;
+	private HashGuiHit hitManager;
 
 
 	/**
@@ -47,10 +50,12 @@ public HashGuiManager setup()
 		this.clickManager = new HashGuiClick();
 		this.interactionManager = new HashGuiInteraction();
 		this.holdManager = new HashGuiHold();
+		this.hitManager = new HashGuiHit();
 
 		this.pluginManager.registerEvents(new HashGuiClickListener(this.clickManager), this.plugin);
 		this.pluginManager.registerEvents(new HashGuiInteractListener(this.interactionManager), this.plugin);
 		this.pluginManager.registerEvents(new HashGuiHoldListener(this.holdManager), this.plugin);
+		this.pluginManager.registerEvents(new HashGuiHitListener(this.hitManager), this.plugin);
 
 		return this;
 	}
@@ -80,4 +85,12 @@ public HashGuiHold getHoldManager()
 		return this.holdManager;
 	}
 
+	/**
+	 * @return	Hit manager
+	 */
+	public HashGuiHit getHitManager()
+	{
+		return this.hitManager;
+	}
+
 }

src/main/java/fr/hashtek/spigot/hashitem/HashItem.java

@@ -4,6 +4,7 @@
 import java.util.List;
 
 import fr.hashtek.spigot.hashgui.handler.hold.HoldHandler;
+import fr.hashtek.spigot.hashgui.handler.hit.HitHandler;
 import org.bukkit.ChatColor;
 import org.bukkit.Material;
 import org.bukkit.enchantments.Enchantment;
@@ -24,6 +25,7 @@ public class HashItem
 	private List<ClickHandler> clickHandlers;
 	private List<InteractHandler> interactHandlers;
 	private List<HoldHandler> holdHandlers;
+	private List<HitHandler> hitHandlers;
 
 
 	/**
@@ -111,13 +113,14 @@ public static HashItem separator(Byte glassColor, HashGuiManager guiManager)
 	 * 
 	 * @return	Returns itself.
 	 */
-	public HashItem build(HashGuiManager guiManager) throws IllegalArgumentException
+	public HashItem build(HashGuiManager guiManager)
 	{
 		this.itemStack.setItemMeta(this.itemMeta);
 
 		guiManager.getClickManager().addClickHandler(this);
 		guiManager.getInteractionManager().addInteractHandler(this);
 		guiManager.getHoldManager().addHoldHandler(this);
+		guiManager.getHitManager().addHitHandler(this);
 		return this;
 	}
 
@@ -126,7 +129,7 @@ public HashItem build(HashGuiManager guiManager) throws IllegalArgumentException
 	 * 
 	 * @return	Returns itself.
 	 */
-	public HashItem build() throws IllegalArgumentException
+	public HashItem build()
 	{
 		this.itemStack.setItemMeta(this.itemMeta);
 		return this;
@@ -433,6 +436,21 @@ public HashItem addHoldHandler(HoldHandler holdHandler)
 		this.holdHandlers.add(holdHandler);
 		return this;
 	}
+
+	/**
+	 * Adds a hit handler to the item.
+	 *
+	 * @param	hitHandler	Hit handler.
+	 * @return	Returns itself.
+	 */
+	public HashItem addHitHandler(HitHandler hitHandler)
+	{
+		if (this.hitHandlers == null)
+			this.hitHandlers = new ArrayList<HitHandler>();
+
+		this.hitHandlers.add(hitHandler);
+		return this;
+	}
 
 	/**
 	 * @return	Item's click handlers.
@@ -458,4 +476,12 @@ public List<HoldHandler> getHoldHandlers()
 		return this.holdHandlers;
 	}
 
+	/**
+	 * @return	Item's hit handlers.
+	 */
+	public List<HitHandler> getHitHandlers()
+	{
+		return this.hitHandlers;
+	}
+
 }