Cynthia Yantis / Bukkit / ccf38a975a6

Commits

Cynthia Yantis authored ccf38a975a6 27 May 2021

Add PlayerBucketEntityEvent and make PlayerBucketFishEvent deprecated in favor of the newer, more generic event

src/main/java/org/bukkit/event/player/PlayerBucketEntityEvent.java

Added

-+
+package org.bukkit.event.player;
-+
-+
+import org.bukkit.Material;
-+
+import org.bukkit.entity.Entity;
-+
+import org.bukkit.entity.Player;
-+
+import org.bukkit.event.Cancellable;
-+
+import org.bukkit.event.HandlerList;
-+
+import org.bukkit.inventory.ItemStack;
-+
+import org.jetbrains.annotations.NotNull;
-+
-+
+/**
-+
+ * This event is called whenever a player captures an entity in a bucket.
-+
+ * <p>
-+
+ * The initial implementation of this event was {@link PlayerBucketFishEvent}, however
-+
+ * due to the release of axolotls in the coming releases, a more generic event was needed
-+
+ * to account for future entities and use cases.
-+
+ * <p>
-+
+ * There is no real benefit offered by {@link PlayerBucketFishEvent}, as it now exists soley for
-+
+ * legacy purposes unless the decided route in the future is to create events per capture type
-+
+ * such as a PlayerBucketAxolotlEvent.
-+
+ */
-+
+public class PlayerBucketEntityEvent extends PlayerEvent implements Cancellable {
-+
-+
+    private static final HandlerList handlers = new HandlerList();
-+
+    private boolean cancelled;
-+
+    private final Entity entity;
-+
+    private final ItemStack originalBucket;
-+
+    private final ItemStack entityBucket;
-+
-+
+    public PlayerBucketEntityEvent(@NotNull Player player, @NotNull Entity entity, @NotNull ItemStack originalBucket, @NotNull ItemStack entityBucket) {
-+
+        super(player);
-+
+        this.entity = entity;
-+
+        this.originalBucket = originalBucket;
-+
+        this.entityBucket = entityBucket;
-+
+    }
-+
-+
+    /**
-+
+     * Gets the {@link Entity} being put into the bucket
-+
+     *
-+
+     * @return The {@link Entity} being put into the bucket
-+
+     */
-+
+    @NotNull
-+
+    public Entity getEntity() {
-+
+        return entity;
-+
+    }
-+
-+
+    /**
-+
+     * Gets the bucket used to capture the {@link Entity}.
-+
+     * <p>
-+
+     * This refers to the bucket clicked with, ie {@link Material#WATER_BUCKET}, or
-+
+     * in future implementations, possibly {@link Material#BUCKET}.
-+
+     *
-+
+     * @return The used bucket
-+
+     */
-+
+    @NotNull
-+
+    public ItemStack getOriginalBucket() {
-+
+        return originalBucket;
-+
+    }
-+
-+
+    /**
-+
+     * Gets the bucket that the {@link Entity} will be put into.
-+
+     * <p>
-+
+     * This refers to the bucket with the entity, ie
-+
+     * {@link Material#PUFFERFISH_BUCKET}.
-+
+     *
-+
+     * @return The bucket that the {@link Entity} will be put into
-+
+     */
-+
+    @NotNull
-+
+    public ItemStack getEntityBucket() {
-+
+        return entityBucket;
-+
+    }
-+
-+
+    @Override
-+
+    public boolean isCancelled() {
-+
+        return cancelled;
-+
+    }
-+
-+
+    @Override
-+
+    public void setCancelled(boolean cancel) {
-+
+        this.cancelled = cancel;
-+
+    }
-+
-+
+    @NotNull
-+
+    @Override
-+
+    public HandlerList getHandlers() {
-+
+        return handlers;
-+
+    }
-+
-+
+    @NotNull
-+
+    public static HandlerList getHandlerList() {
-+
+        return handlers;
-+
+    }
-+
+}

Bukkit

Commits

Jira Issues

Add shortcut