Paper/patches/api/0122-PlayerLaunchProjectileEvent.patch

105 lines
3.1 KiB
Diff
Raw Permalink Normal View History

2021-06-11 14:02:28 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: BillyGalbreath <Blake.Galbreath@GMail.com>
Date: Sat, 21 Jul 2018 03:10:50 -0500
Subject: [PATCH] PlayerLaunchProjectileEvent
diff --git a/src/main/java/com/destroystokyo/paper/event/player/PlayerLaunchProjectileEvent.java b/src/main/java/com/destroystokyo/paper/event/player/PlayerLaunchProjectileEvent.java
new file mode 100644
index 0000000000000000000000000000000000000000..a6d483e6be8b8527d7cfd676f6056179e8e9bf33
2021-06-11 14:02:28 +02:00
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/player/PlayerLaunchProjectileEvent.java
@@ -0,0 +1,92 @@
2021-06-11 14:02:28 +02:00
+package com.destroystokyo.paper.event.player;
+
+import org.bukkit.entity.Player;
+import org.bukkit.entity.Projectile;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
2024-02-01 10:15:57 +01:00
+import org.bukkit.event.entity.EntityShootBowEvent;
2021-06-11 14:02:28 +02:00
+import org.bukkit.event.player.PlayerEvent;
+import org.bukkit.inventory.ItemStack;
2024-02-01 10:15:57 +01:00
+import org.jetbrains.annotations.ApiStatus;
+import org.jspecify.annotations.NullMarked;
2021-06-11 14:02:28 +02:00
+
+/**
+ * Called when a player shoots a projectile.
+ * <p>
+ * Notably this event is not called for arrows as the player does not launch them, rather shoots them with the help
2024-02-01 10:15:57 +01:00
+ * of a bow or crossbow. A plugin may listen to {@link EntityShootBowEvent}
+ * for these actions instead.
2021-06-11 14:02:28 +02:00
+ */
+@NullMarked
2021-06-11 14:02:28 +02:00
+public class PlayerLaunchProjectileEvent extends PlayerEvent implements Cancellable {
2024-02-01 10:15:57 +01:00
+
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
+ private final Projectile projectile;
+ private final ItemStack itemStack;
2021-06-11 14:02:28 +02:00
+ private boolean consumeItem = true;
2024-02-01 10:15:57 +01:00
+
2021-06-11 14:02:28 +02:00
+ private boolean cancelled;
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
+ public PlayerLaunchProjectileEvent(final Player shooter, final ItemStack itemStack, final Projectile projectile) {
2021-06-11 14:02:28 +02:00
+ super(shooter);
+ this.itemStack = itemStack;
+ this.projectile = projectile;
+ }
+
+ /**
+ * Gets the projectile which will be launched by this event
+ *
+ * @return the launched projectile
+ */
+ public Projectile getProjectile() {
2024-02-01 10:15:57 +01:00
+ return this.projectile;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Get the ItemStack used to fire the projectile
+ *
+ * @return The ItemStack used
+ */
+ public ItemStack getItemStack() {
2024-02-01 10:15:57 +01:00
+ return this.itemStack;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Get whether to consume the ItemStack or not
+ *
2024-02-01 10:15:57 +01:00
+ * @return {@code true} to consume
2021-06-11 14:02:28 +02:00
+ */
+ public boolean shouldConsume() {
2024-02-01 10:15:57 +01:00
+ return this.consumeItem;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Set whether to consume the ItemStack or not
+ *
2024-02-01 10:15:57 +01:00
+ * @param consumeItem {@code true} to consume
2021-06-11 14:02:28 +02:00
+ */
+ public void setShouldConsume(final boolean consumeItem) {
2021-06-11 14:02:28 +02:00
+ this.consumeItem = consumeItem;
+ }
+
2024-02-01 10:15:57 +01:00
+ @Override
2021-06-11 14:02:28 +02:00
+ public boolean isCancelled() {
2024-02-01 10:15:57 +01:00
+ return this.cancelled;
2021-06-11 14:02:28 +02:00
+ }
+
2024-02-01 10:15:57 +01:00
+ @Override
+ public void setCancelled(final boolean cancel) {
2024-02-01 10:15:57 +01:00
+ this.cancelled = cancel;
2021-06-11 14:02:28 +02:00
+ }
+
+ @Override
+ public HandlerList getHandlers() {
2024-02-01 10:15:57 +01:00
+ return HANDLER_LIST;
2021-06-11 14:02:28 +02:00
+ }
+
+ public static HandlerList getHandlerList() {
2024-02-01 10:15:57 +01:00
+ return HANDLER_LIST;
2021-06-11 14:02:28 +02:00
+ }
+}