Paper/patches/api/0249-Added-PlayerChangeBeaconEffectEvent.patch

150 lines
4.4 KiB
Diff
Raw Normal View History

2021-06-11 14:02:28 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Wed, 24 Jun 2020 15:12:18 -0600
Subject: [PATCH] Added PlayerChangeBeaconEffectEvent
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerChangeBeaconEffectEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerChangeBeaconEffectEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..1cc5dfb6d31f312f07acb1d5fb4719d6f4c2c4ff
2021-06-11 14:02:28 +02:00
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/player/PlayerChangeBeaconEffectEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,137 @@
2021-06-11 14:02:28 +02:00
+package io.papermc.paper.event.player;
+
+import org.bukkit.block.Block;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.player.PlayerEvent;
+import org.bukkit.potion.PotionEffectType;
2023-09-14 12:44:12 +02:00
+import org.jetbrains.annotations.ApiStatus;
2021-06-11 14:02:28 +02:00
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Called when a player sets the effect for a beacon
+ */
+public class PlayerChangeBeaconEffectEvent extends PlayerEvent implements Cancellable {
2024-02-01 10:15:57 +01:00
+
2023-09-14 12:44:12 +02:00
+ private static final HandlerList HANDLER_LIST = new HandlerList();
2021-06-11 14:02:28 +02:00
+
2024-02-01 10:15:57 +01:00
+ private final Block beacon;
2021-06-11 14:02:28 +02:00
+ private PotionEffectType primary;
+ private PotionEffectType secondary;
+ private boolean consumeItem = true;
+
2024-02-01 10:15:57 +01:00
+ private boolean cancelled;
2021-06-11 14:02:28 +02:00
+
2023-09-14 12:44:12 +02:00
+ @ApiStatus.Internal
+ public PlayerChangeBeaconEffectEvent(@NotNull Player player, @Nullable PotionEffectType primary, @Nullable PotionEffectType secondary, @NotNull Block beacon) {
2021-06-11 14:02:28 +02:00
+ super(player);
+ this.primary = primary;
+ this.secondary = secondary;
+ this.beacon = beacon;
+ }
+
+ /**
+ * @return the primary effect
+ */
+ @Nullable public PotionEffectType getPrimary() {
2024-02-01 10:15:57 +01:00
+ return this.primary;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Sets the primary effect
+ * <p>
+ * NOTE: The primary effect still has to be one of the valid effects for a beacon.
+ *
+ * @param primary the primary effect
+ */
+ public void setPrimary(@Nullable PotionEffectType primary) {
+ this.primary = primary;
+ }
+
+ /**
+ * @return the secondary effect
+ */
+ @Nullable public PotionEffectType getSecondary() {
2024-02-01 10:15:57 +01:00
+ return this.secondary;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Sets the secondary effect
+ * <p>
+ * This only has an effect when the beacon is able to accept a secondary effect.
+ * NOTE: The secondary effect still has to be a valid effect for a beacon.
+ *
+ * @param secondary the secondary effect
+ */
+ public void setSecondary(@Nullable PotionEffectType secondary) {
+ this.secondary = secondary;
+ }
+
+ /**
2023-09-14 12:44:12 +02:00
+ * @return the beacon block associated with this event
2021-06-11 14:02:28 +02:00
+ */
2023-09-14 12:44:12 +02:00
+ @NotNull
2021-06-11 14:02:28 +02:00
+ public Block getBeacon() {
2024-02-01 10:15:57 +01:00
+ return this.beacon;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Gets if the item used to change the beacon will be consumed.
2021-06-11 14:02:28 +02:00
+ * <p>
+ * Independent of {@link #isCancelled()}. If the event is cancelled
2021-06-11 14:02:28 +02:00
+ * the item will <b>NOT</b> be consumed.
+ *
2024-02-01 10:15:57 +01:00
+ * @return {@code true} if item will be consumed
2021-06-11 14:02:28 +02:00
+ */
+ public boolean willConsumeItem() {
2024-02-01 10:15:57 +01:00
+ return this.consumeItem;
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Sets if the item used to change the beacon should be consumed.
+ * <p>
+ * Independent of {@link #isCancelled()}. If the event is cancelled
2021-06-11 14:02:28 +02:00
+ * the item will <b>NOT</b> be consumed.
+ *
2024-02-01 10:15:57 +01:00
+ * @param consumeItem {@code true} if item should be consumed
2021-06-11 14:02:28 +02:00
+ */
+ public void setConsumeItem(boolean consumeItem) {
+ this.consumeItem = consumeItem;
+ }
+
+ /**
2024-02-01 10:15:57 +01:00
+ * {@inheritDoc}
2021-06-11 14:02:28 +02:00
+ * <p>
+ * If a {@link PlayerChangeBeaconEffectEvent} is cancelled, the changes will
+ * not take effect
+ */
+ @Override
+ 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
+ * {@inheritDoc}
2021-06-11 14:02:28 +02:00
+ * <p>
+ * If cancelled, the item will <b>NOT</b> be consumed regardless of what {@link #willConsumeItem()} says
+ * <p>
+ * If a {@link PlayerChangeBeaconEffectEvent} is cancelled, the changes will not be applied
+ * or saved.
+ */
+ @Override
+ public void setCancelled(boolean cancel) {
2024-02-01 10:15:57 +01:00
+ this.cancelled = cancel;
2021-06-11 14:02:28 +02:00
+ }
+
+ @Override
+ public @NotNull HandlerList getHandlers() {
2023-09-14 12:44:12 +02:00
+ return HANDLER_LIST;
2021-06-11 14:02:28 +02:00
+ }
+
+ @NotNull
+ public static HandlerList getHandlerList() {
2023-09-14 12:44:12 +02:00
+ return HANDLER_LIST;
2021-06-11 14:02:28 +02:00
+ }
+}