Merge pull request #703 from Lorenzo0111/copilot/suggest-use-q-to-unload-weapon

Add weapon unload feature using Q key with sneak modifier

Author: Lorenzo0111

src/main/java/me/zombie_striker/qg/QAMain.java

@@ -135,6 +135,7 @@ public class QAMain extends JavaPlugin {
     public static boolean reloadOnQ = true;
     public static boolean reloadOnF = true;
     public static boolean reloadOnFOnly = true;
+    public static boolean unloadOnQ = false;
     public static boolean disableHotBarMessageOnShoot = false;
     public static boolean disableHotBarMessageOnReload = false;
     public static boolean disableHotBarMessageOnOutOfAmmo = false;
@@ -864,6 +865,7 @@ public void reloadVals() {
         reloadOnQ = (boolean) a("enableReloadingOnDrop", false);
         reloadOnF = (boolean) a("enableReloadingWhenSwapToOffhand", true);
         reloadOnFOnly = (boolean) a("enableReloadOnlyWhenSwapToOffhand", false);
+        unloadOnQ = (boolean) a("enableUnloadingOnDrop", false);
 
         allowGunHitEntities = (boolean) a("allowGunHitEntities", true);
         preventHiddenPlayers = (boolean) a("preventHiddenPlayers", true);

src/main/java/me/zombie_striker/qg/listener/QAListener.java

@@ -13,6 +13,7 @@
 import me.zombie_striker.qg.guns.Gun;
 import me.zombie_striker.qg.guns.utils.GunRefillerRunnable;
 import me.zombie_striker.qg.guns.utils.GunUtil;
+import me.zombie_striker.qg.guns.utils.WeaponSounds;
 import me.zombie_striker.qg.handlers.BulletWoundHandler;
 import me.zombie_striker.qg.handlers.IronsightsHandler;
 import me.zombie_striker.qg.handlers.Update19OffhandChecker;
@@ -465,12 +466,35 @@ public void onPickup(PlayerPickupItemEvent e) {
 
 	@EventHandler(priority = EventPriority.LOW)
 	public void onDropReload(PlayerDropItemEvent e) {
-		if (QAMain.reloadOnQ && !QAMain.reloadOnFOnly) {
-			Gun g = QualityArmory.getGun(e.getItemDrop().getItemStack());
-			if (g != null) {
-				e.setCancelled(true);
-				reload(e.getPlayer(),g);
-			}
+		ItemStack droppedItem = e.getItemDrop().getItemStack();
+
+		Gun g = QualityArmory.getGun(droppedItem);
+		if (g == null && QualityArmory.isIronSights(droppedItem))
+			g = QualityArmory.getGun(e.getPlayer().getInventory().getItemInOffHand());
+
+		if (g == null) return;
+
+		Gun finalG = g;
+		if (QAMain.unloadOnQ) {
+			e.setCancelled(true);
+
+			ignoreClick.add(e.getPlayer().getUniqueId());
+
+			Bukkit.getScheduler().runTaskLater(QAMain.getInstance(), () -> {
+				ignoreClick.remove(e.getPlayer().getUniqueId());
+
+				if (e.getPlayer().isSneaking()) unloadAll(e.getPlayer(), finalG);
+				else unloadOne(e.getPlayer(), finalG);
+			}, 2L);
+		} else if (QAMain.reloadOnQ && !QAMain.reloadOnFOnly) {
+			e.setCancelled(true);
+			
+			ignoreClick.add(e.getPlayer().getUniqueId());
+
+			Bukkit.getScheduler().runTaskLater(QAMain.getInstance(), () -> {
+				ignoreClick.remove(e.getPlayer().getUniqueId());
+				reload(e.getPlayer(), finalG);
+			}, 2L);
 		}
 	}
 
@@ -480,6 +504,54 @@ public static void reload(Player player, Gun g) {
 		}
 	}
 
+	public static void unloadOne(Player player, Gun g) {
+		int currentAmmo = Gun.getAmount(player);
+		if (currentAmmo <= 0) {
+			QAMain.DEBUG("No ammo to unload");
+			return;
+		}
+
+		QAMain.DEBUG("Unloading one bullet from " + g.getDisplayName());
+		Gun.updateAmmo(g, player, currentAmmo - 1);
+
+		if (g.getAmmoType() != null) {
+			QAMain.DEBUG("Returning one bullet to player inventory");
+			QualityArmory.addAmmoToInventory(player, g.getAmmoType(), 1);
+		}
+
+		playUnloadSound(player);
+	}
+
+	public static void unloadAll(Player player, Gun g) {
+		int currentAmmo = Gun.getAmount(player);
+		if (currentAmmo <= 0) {
+			QAMain.DEBUG("No ammo to unload");
+			return;
+		}
+
+		QAMain.DEBUG("Unloading all ammo from " + g.getDisplayName());
+		Gun.updateAmmo(g, player, 0);
+
+		if (g.getAmmoType() != null) {
+			QAMain.DEBUG("Returning all ammo to player inventory");
+			QualityArmory.addAmmoToInventory(player, g.getAmmoType(), currentAmmo);
+		}
+
+		playUnloadSound(player);
+	}
+
+	private static void playUnloadSound(Player player) {
+		try {
+			player.getWorld().playSound(player.getLocation(), WeaponSounds.RELOAD_MAG_OUT.getSoundName(), 1, 0.8f);
+		} catch (Error e2) {
+			try {
+				player.getWorld().playSound(player.getLocation(), Sound.valueOf("CLICK"), 1, 0.8f);
+			} catch (Error | Exception e3) {
+				player.getWorld().playSound(player.getLocation(), Sound.valueOf("BLOCK_LEVER_CLICK"), 1, 0.8f);
+			}
+		}
+	}
+
 	@EventHandler
 	public void onMove(PlayerMoveEvent e) {
 		QAMain.recoilHelperMovedLocation.put(e.getPlayer().getUniqueId(), e.getTo());
@@ -678,6 +750,11 @@ public void onAnvilClick(final PlayerInteractEvent e) {
 	@SuppressWarnings({"deprecation"})
 	@EventHandler(priority = EventPriority.LOWEST)
 	public void onClick(final PlayerInteractEvent e) {
+		// Prevent shooting/interaction immediately after unload/reload
+		if (ignoreClick.contains(e.getPlayer().getUniqueId())) {
+			return;
+		}
+		
 		QAMain.DEBUG("InteractEvent Called. Custom item used = " + QualityArmory.isCustomItem(e.getPlayer().getItemInHand()));
 		if (!CustomItemManager.isUsingCustomData()) {
 			QAMain.DEBUG("Custom Data Check");

wiki/config/main.md

@@ -98,4 +98,5 @@ Below you can find a list of all the options that you can configure and their ex
 * **weaponSwitchDelay**: `0` - The delay in seconds before a player can fire after switching weapon. A value of `0` means no delay.
 * **DefaultResourcepack**: Defines the resource pack URLs. Refer to [ResourcePack Configuration](resourcepack.md) for more information.
 * **restoreOffHand**: `false` - If `true`, restores the off-hand item after iron sights are unaimed.
-* **hitDistance**: `5` - The maximum distance (in blocks) at which a gun can register melee hits on entities when using the gun to hit directly.
+* **hitDistance**: `5` - The maximum distance (in blocks) at which a gun can register melee hits on entities when using the gun to hit directly.
+* **enableUnloadingOnDrop**: `false` - If `true`, allows players to unload their gun's magazine by pressing their drop key (default 'Q') while holding a gun.