mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-24 19:56:25 +00:00
52a05907c7
Upstream has released updates that appear to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: 97c59261 PR-1073: Make Biome an interface a38581aa Fix further javadoc errors 8271c490 Fix javadoc error 8a9ecf29 PR-1072: Fix bad naming for Vault State methods 6dd58108 PR-1071: Make Fluid an interface and add missing entry ed2cdfc3 PR-1070: Make Attribute an interface and align names with the new minecraft ones 63472efb PR-1069: Add missing winter drop experimental annotation to pale boats CraftBukkit Changes: 7235ad7b0 PR-1501: Make Biome an interface 602904003 PR-1500: Rename implementation for Vault State methods 75f26f79f PR-1499: Make Fluid an interface and add missing entry 4cfd87adc PR-1498: Make Attribute an interface and align names with the new minecraft ones 6bb0db5cb SPIGOT-7928: ExactChoice acts as MaterialChoice 3eaf3a13c SPIGOT-7929: Error when setting EquippableComponent abbf57bac SPIGOT-7930: Fix spawning entities with SummonEntityEffect 92d6ab6cf PR-1497: Move boat field rename entries to below key renaming, so that keys are also renamed abfe292aa PR-1496: Use correct Fluid class on Tags type check c7aab7fa7 SPIGOT-7923: Fix Dispenser logic to avoid firing empty projectiles
114 lines
4.0 KiB
Diff
114 lines
4.0 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Cryptite <cryptite@gmail.com>
|
|
Date: Mon, 1 May 2023 16:22:43 -0500
|
|
Subject: [PATCH] Add PlayerShieldDisableEvent
|
|
|
|
Called whenever a players shield is disabled. This is mainly caused by
|
|
attacking players or monsters that carry axes.
|
|
|
|
The event, while similar to the PlayerItemCooldownEvent, offers other
|
|
behaviour and can hence not be implemented as a childtype of said event.
|
|
Specifically, cancelling the event prevents the game events from being
|
|
sent to the player.
|
|
|
|
Plugins listening to just the PlayerItemCooldownEvent may not want said
|
|
sideeffects, meaning the disable event cannot share a handlerlist with
|
|
the cooldown event.
|
|
|
|
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerShieldDisableEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerShieldDisableEvent.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..aa2fb7923b121cda547291d14cff60895361a4dd
|
|
--- /dev/null
|
|
+++ b/src/main/java/io/papermc/paper/event/player/PlayerShieldDisableEvent.java
|
|
@@ -0,0 +1,90 @@
|
|
+package io.papermc.paper.event.player;
|
|
+
|
|
+import com.google.common.base.Preconditions;
|
|
+import org.bukkit.entity.Entity;
|
|
+import org.bukkit.entity.Player;
|
|
+import org.bukkit.event.Cancellable;
|
|
+import org.bukkit.event.HandlerList;
|
|
+import org.bukkit.event.player.PlayerEvent;
|
|
+import org.jetbrains.annotations.ApiStatus;
|
|
+import org.jspecify.annotations.NullMarked;
|
|
+
|
|
+/**
|
|
+ * Called whenever a players shield is disabled due to an attack from another entity that was capable of disabling the
|
|
+ * shield. This, most commonly, may be another player attacking with an axe.
|
|
+ * <p>
|
|
+ * Notably, this even is distinct from a {@link PlayerItemCooldownEvent} and will fire prior to the item going on
|
|
+ * cooldown.
|
|
+ * It follows that, if this event is cancelled, no {@link PlayerItemCooldownEvent} is called as the shield is never
|
|
+ * disabled in the first place.
|
|
+ */
|
|
+@NullMarked
|
|
+public class PlayerShieldDisableEvent extends PlayerEvent implements Cancellable {
|
|
+
|
|
+ private static final HandlerList HANDLER_LIST = new HandlerList();
|
|
+
|
|
+ private final Entity damager;
|
|
+ private int cooldown;
|
|
+
|
|
+ private boolean cancelled;
|
|
+
|
|
+ @ApiStatus.Internal
|
|
+ public PlayerShieldDisableEvent(final Player player, final Entity damager, final int cooldown) {
|
|
+ super(player);
|
|
+ this.damager = damager;
|
|
+ this.cooldown = cooldown;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Provides the damager that disabled the shield.
|
|
+ *
|
|
+ * @return the entity instance that damaged the player in a way that caused the shield to be disabled.
|
|
+ */
|
|
+ public Entity getDamager() {
|
|
+ return this.damager;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the cooldown the disabled shield will be disabled for in ticks.
|
|
+ * <p>
|
|
+ * Notably, this value is not final as it might be changed by a {@link PlayerItemCooldownEvent} down the line,
|
|
+ * as said event is called if this event is not cancelled.
|
|
+ *
|
|
+ * @return cooldown in ticks
|
|
+ */
|
|
+ public int getCooldown() {
|
|
+ return this.cooldown;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Sets the cooldown of the shield in ticks.
|
|
+ * <p>
|
|
+ * Notably, this value is not final as it might be changed by a {@link PlayerItemCooldownEvent} down the line,
|
|
+ * as said event is called if this event is not cancelled.
|
|
+ *
|
|
+ * @param cooldown cooldown in ticks, has to be a positive number
|
|
+ */
|
|
+ public void setCooldown(final int cooldown) {
|
|
+ Preconditions.checkArgument(cooldown >= 0, "The cooldown has to be equal to or greater than 0!");
|
|
+ this.cooldown = cooldown;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean isCancelled() {
|
|
+ return this.cancelled;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public void setCancelled(final boolean cancel) {
|
|
+ this.cancelled = cancel;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public HandlerList getHandlers() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ public static HandlerList getHandlerList() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+}
|