Add player_stop_using_item event

Paper Only

Author: PseudoKnight

src/main/java/com/laytonsmith/abstraction/bukkit/BukkitConvertor.java

@@ -374,7 +374,7 @@ public void Startup(CommandHelperPlugin chp) {
 		chp.registerEvents(BLOCK_LISTENER);
 		chp.registerEvents(ENTITY_LISTENER);
 		chp.registerEventsDynamic(INVENTORY_LISTENER);
-		chp.registerEvents(PLAYER_LISTENER);
+		chp.registerEventsDynamic(PLAYER_LISTENER);
 		chp.registerEvents(SERVER_LISTENER);
 		chp.registerEvents(VEHICLE_LISTENER);
 		chp.registerEvents(WEATHER_LISTENER);

src/main/java/com/laytonsmith/abstraction/bukkit/events/BukkitPlayerEvents.java

@@ -67,6 +67,7 @@
 import com.laytonsmith.abstraction.events.MCPlayerQuitEvent;
 import com.laytonsmith.abstraction.events.MCPlayerResourcePackEvent;
 import com.laytonsmith.abstraction.events.MCPlayerRespawnEvent;
+import com.laytonsmith.abstraction.events.MCPlayerStopUsingItemEvent;
 import com.laytonsmith.abstraction.events.MCPlayerTeleportEvent;
 import com.laytonsmith.abstraction.events.MCPlayerToggleFlightEvent;
 import com.laytonsmith.abstraction.events.MCPlayerToggleSneakEvent;
@@ -75,6 +76,7 @@
 import com.laytonsmith.annotations.abstraction;
 import com.laytonsmith.core.Static;
 import io.papermc.paper.advancement.AdvancementDisplay;
+import io.papermc.paper.event.player.PlayerStopUsingItemEvent;
 import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
@@ -1192,4 +1194,26 @@ public String getTitle() {
 			return null;
 		}
 	}
+
+	@abstraction(type = Implementation.Type.BUKKIT)
+	public static class BukkitMCPlayerStopUsingItemEvent extends BukkitMCPlayerEvent implements MCPlayerStopUsingItemEvent {
+
+		PlayerStopUsingItemEvent e;
+
+		public BukkitMCPlayerStopUsingItemEvent(PlayerStopUsingItemEvent event) {
+			super(event);
+			this.e = event;
+		}
+
+		@Override
+		public MCItemStack getItem() {
+			return new BukkitMCItemStack(this.e.getItem());
+		}
+
+		@Override
+		public int getTicksHeldFor() {
+			return this.e.getTicksHeldFor();
+		}
+
+	}
 }

src/main/java/com/laytonsmith/abstraction/bukkit/events/drivers/BukkitPlayerListener.java

@@ -24,17 +24,21 @@
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerQuitEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerRespawnEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerResourcePackEvent;
+import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerStopUsingItemEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerTeleportEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerToggleFlightEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerToggleSneakEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCPlayerToggleSprintEvent;
 import com.laytonsmith.abstraction.bukkit.events.BukkitPlayerEvents.BukkitMCWorldChangedEvent;
+import com.laytonsmith.annotations.EventIdentifier;
 import com.laytonsmith.commandhelper.CommandHelperPlugin;
 import com.laytonsmith.core.events.Driver;
 import com.laytonsmith.core.events.EventUtils;
 import com.laytonsmith.core.events.drivers.PlayerEvents;
+import io.papermc.paper.event.player.PlayerStopUsingItemEvent;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
+import org.bukkit.event.Event;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
@@ -393,4 +397,10 @@ public void onPlayerAdvancementDoneEvent(PlayerAdvancementDoneEvent event) {
 		BukkitMCPlayerAdvancementDoneEvent pade = new BukkitMCPlayerAdvancementDoneEvent(event);
 		EventUtils.TriggerListener(Driver.PLAYER_ADVANCEMENT_DONE, "player_advancement_done", pade);
 	}
+
+	@EventIdentifier(event = Driver.PLAYER_STOP_USING_ITEM, className = "io.papermc.paper.event.player.PlayerStopUsingItemEvent")
+	public void onPlayerStopUsingItemEvent(Event event) {
+		BukkitMCPlayerStopUsingItemEvent psuie = new BukkitMCPlayerStopUsingItemEvent((PlayerStopUsingItemEvent) event);
+		EventUtils.TriggerListener(Driver.PLAYER_STOP_USING_ITEM, "player_stop_using_item", psuie);
+	}
 }

src/main/java/com/laytonsmith/abstraction/events/MCPlayerStopUsingItemEvent.java

@@ -0,0 +1,8 @@
+package com.laytonsmith.abstraction.events;
+
+import com.laytonsmith.abstraction.MCItemStack;
+
+public interface MCPlayerStopUsingItemEvent extends MCPlayerEvent {
+	MCItemStack getItem();
+	int getTicksHeldFor();
+}

src/main/java/com/laytonsmith/commandhelper/CommandHelperPlugin.java

@@ -475,10 +475,14 @@ public void registerEventsDynamic(Listener listener) {
 				try {
 					eventClass = (Class<? extends Event>) Class.forName(identifier.className());
 				} catch (ClassNotFoundException | ClassCastException e) {
-					MSLog.GetLogger().e(MSLog.Tags.RUNTIME, "Could not listen for " + identifier.event().name()
-							+ " because the class " + identifier.className() + " could not be found."
-							+ " This problem is not expected to occur, so please report it on the bug"
-							+ " tracker if it does.", Target.UNKNOWN);
+					// Event may only exist in Paper (io.papermc.paper or com.destroytokyo.paper)
+					// so when running Spigot, ignore events that are not in org.bukkit.event or org.spigotmc.event.
+					if(identifier.className().startsWith("org") || ((BukkitMCServer) myServer).isPaper()) {
+						MSLog.GetLogger().e(MSLog.Tags.RUNTIME, "Could not listen for " + identifier.event().name()
+								+ " because the class " + identifier.className() + " could not be found."
+								+ " This problem is not expected to occur, so please report it on the bug"
+								+ " tracker if it does.", Target.UNKNOWN);
+					}
 					continue;
 				}
 			}

src/main/java/com/laytonsmith/core/events/Driver.java

@@ -95,6 +95,7 @@ public enum Driver {
 	PLAYER_PORTAL_TRAVEL,
 	PLAYER_QUIT,
 	PLAYER_SPAWN,
+	PLAYER_STOP_USING_ITEM(MCVersion.MC1_18_X),
 	PLAYER_TOGGLE_FLIGHT,
 	PLAYER_TOGGLE_SNEAK,
 	PLAYER_TOGGLE_SPRINT,

src/main/java/com/laytonsmith/core/events/drivers/PlayerEvents.java

@@ -43,6 +43,7 @@
 import com.laytonsmith.abstraction.events.MCPlayerQuitEvent;
 import com.laytonsmith.abstraction.events.MCPlayerResourcePackEvent;
 import com.laytonsmith.abstraction.events.MCPlayerRespawnEvent;
+import com.laytonsmith.abstraction.events.MCPlayerStopUsingItemEvent;
 import com.laytonsmith.abstraction.events.MCPlayerTeleportEvent;
 import com.laytonsmith.abstraction.events.MCPlayerToggleFlightEvent;
 import com.laytonsmith.abstraction.events.MCPlayerToggleSneakEvent;
@@ -2958,4 +2959,69 @@ public BindableEvent convert(CArray manualObject, Target t) {
 			return null;
 		}
 	}
+
+	@api
+	public static class player_stop_using_item extends AbstractEvent {
+
+		@Override
+		public String getName() {
+			return "player_stop_using_item";
+		}
+
+		@Override
+		public Driver driver() {
+			return Driver.PLAYER_STOP_USING_ITEM;
+		}
+
+		@Override
+		public String docs() {
+			return "{}"
+					+ " Fires when a player stops using an item, such as shields, bows, crossbows, tridents, brushes,"
+					+ " goat horns, or spyglasses. Edible items will also fire this if the player stops consuming"
+					+ " before completion. This event cannot be cancelled and is only available on Paper 1.18.2+."
+					+ " {player | item: The item that was used. | ticks: The number of ticks the item was used.)}"
+					+ " {}"
+					+ " {}";
+		}
+
+		@Override
+		protected PrefilterBuilder getPrefilterBuilder() {
+			return new PrefilterBuilder<MCPlayerStopUsingItemEvent>()
+					.set("player", "The player that was using the item.", new PlayerPrefilterMatcher<>())
+					.set("itemname", "The item type being used", new ItemStackPrefilterMatcher<>() {
+						@Override
+						protected MCItemStack getItemStack(MCPlayerStopUsingItemEvent event) {
+							return event.getItem();
+						}
+					});
+		}
+
+		@Override
+		public Map<String, Mixed> evaluate(BindableEvent event) throws EventException {
+			if(event instanceof MCPlayerStopUsingItemEvent e) {
+				Map<String, Mixed> map = new HashMap<>();
+				map.put("player", new CString(e.getPlayer().getName(), Target.UNKNOWN));
+				map.put("item", ObjectGenerator.GetGenerator().item(e.getItem(), Target.UNKNOWN));
+				map.put("ticks", new CInt(e.getTicksHeldFor(), Target.UNKNOWN));
+				return map;
+			} else {
+				throw new EventException("Event received was not an MCPlayerStopUsingItemEvent.");
+			}
+		}
+
+		@Override
+		public boolean modifyEvent(String key, Mixed value, BindableEvent event) {
+			return false;
+		}
+
+		@Override
+		public MSVersion since() {
+			return MSVersion.V3_3_5;
+		}
+
+		@Override
+		public BindableEvent convert(CArray manualObject, Target t) {
+			return null;
+		}
+	}
 }