Obsidian/patches/api/0285-Add-WaterBottleSplashEvent.patch
Jake Potrebic f9c7f2a5c1
Begin switching to JSpecify annotations (#11448)
* Begin switching to JSpecify annotations

* more

* fixes
2024-09-29 12:52:13 -07:00

160 lines
5.7 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jason Penilla <11360596+jpenilla@users.noreply.github.com>
Date: Thu, 8 Dec 2022 10:12:23 -0700
Subject: [PATCH] Add WaterBottleSplashEvent
diff --git a/src/main/java/io/papermc/paper/event/entity/WaterBottleSplashEvent.java b/src/main/java/io/papermc/paper/event/entity/WaterBottleSplashEvent.java
new file mode 100644
index 0000000000000000000000000000000000000000..1f74ea11c726273c3c2a7fc6f381716e230ef5c9
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/entity/WaterBottleSplashEvent.java
@@ -0,0 +1,135 @@
+package io.papermc.paper.event.entity;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+import org.bukkit.block.Block;
+import org.bukkit.block.BlockFace;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.ThrownPotion;
+import org.bukkit.event.entity.PotionSplashEvent;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Called when a splash water potion "splashes" and affects
+ * different entities in different ways.
+ */
+@NullMarked
+public class WaterBottleSplashEvent extends PotionSplashEvent {
+
+ private final Set<LivingEntity> rehydrate;
+ private final Set<LivingEntity> extinguish;
+
+ @ApiStatus.Internal
+ public WaterBottleSplashEvent(
+ final ThrownPotion potion,
+ final @Nullable Entity hitEntity,
+ final @Nullable Block hitBlock,
+ final @Nullable BlockFace hitFace,
+ final Map<LivingEntity, Double> affectedEntities,
+ final Set<LivingEntity> rehydrate,
+ final Set<LivingEntity> extinguish
+ ) {
+ super(potion, hitEntity, hitBlock, hitFace, affectedEntities);
+ this.rehydrate = rehydrate;
+ this.extinguish = extinguish;
+ }
+
+ /**
+ * Gets an immutable collection of entities that
+ * will take damage as a result of this event. Use
+ * other methods on this class to modify which entities
+ * take damage.
+ *
+ * @return an immutable collection of entities
+ * @see #doNotDamageAsWaterSensitive(LivingEntity)
+ * @see #damageAsWaterSensitive(LivingEntity)
+ */
+ public @Unmodifiable Collection<LivingEntity> getToDamage() {
+ return this.affectedEntities.entrySet().stream().filter(entry -> entry.getValue() > 0).map(Map.Entry::getKey).collect(Collectors.toUnmodifiableSet());
+ }
+
+ /**
+ * Removes this entity from the group that
+ * will be damaged.
+ *
+ * @param entity entity to remove
+ */
+ public void doNotDamageAsWaterSensitive(final LivingEntity entity) {
+ this.affectedEntities.remove(entity);
+ }
+
+ /**
+ * Adds this entity to the group that
+ * will be damaged
+ *
+ * @param entity entity to add
+ */
+ public void damageAsWaterSensitive(final LivingEntity entity) {
+ this.affectedEntities.put(entity, 1.0);
+ }
+
+ /**
+ * Get a mutable collection of entities
+ * that will be rehydrated by this.
+ * <p>
+ * As of 1.19.3 this only will contain Axolotls as they
+ * are the only entity type that can be rehydrated, but
+ * it may change in the future.
+ *
+ * @return the entities
+ */
+ public Collection<LivingEntity> getToRehydrate() {
+ return this.rehydrate;
+ }
+
+ /**
+ * Get a mutable collection of entities that will
+ * be extinguished as a result of this event.
+ *
+ * @return entities to be extinguished
+ */
+ public Collection<LivingEntity> getToExtinguish() {
+ return this.extinguish;
+ }
+
+ /**
+ * @return a confusing collection, don't use it
+ * @deprecated Use {@link #getToDamage()}
+ */
+ @Deprecated(since = "1.19.3")
+ @Override
+ public Collection<LivingEntity> getAffectedEntities() {
+ return super.getAffectedEntities();
+ }
+
+ /**
+ * Doesn't make sense for this event as intensity doesn't vary.
+ *
+ * @return a confusing value
+ * @deprecated check if {@link #getToDamage()} contains an entity
+ */
+ @Deprecated(since = "1.19.3")
+ @Override
+ public double getIntensity(final LivingEntity entity) {
+ return super.getIntensity(entity);
+ }
+
+ /**
+ * Doesn't make sense for this event as intensity doesn't vary.
+ *
+ * @deprecated use {@link #damageAsWaterSensitive(LivingEntity)}
+ * or {@link #doNotDamageAsWaterSensitive(LivingEntity)} to change which entities are
+ * damaged
+ */
+ @Deprecated(since = "1.19.3")
+ @Override
+ public void setIntensity(final LivingEntity entity, final double intensity) {
+ super.setIntensity(entity, intensity);
+ }
+}
diff --git a/src/main/java/org/bukkit/event/entity/PotionSplashEvent.java b/src/main/java/org/bukkit/event/entity/PotionSplashEvent.java
index bc6ba6c4c07cacfc6ab7a2a72b12dfba110ba911..2e58b716fdb21026d2ee838e81559601344c8a00 100644
--- a/src/main/java/org/bukkit/event/entity/PotionSplashEvent.java
+++ b/src/main/java/org/bukkit/event/entity/PotionSplashEvent.java
@@ -20,7 +20,7 @@ import org.jetbrains.annotations.Nullable;
public class PotionSplashEvent extends ProjectileHitEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
private boolean cancelled;
- private final Map<LivingEntity, Double> affectedEntities;
+ protected final Map<LivingEntity, Double> affectedEntities; // Paper
@Deprecated
public PotionSplashEvent(@NotNull final ThrownPotion potion, @NotNull final Map<LivingEntity, Double> affectedEntities) {