org.bukkit.event.player

Class PlayerBucketFishEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerBucketFishEvent

All Implemented Interfaces:

Cancellable

public class PlayerBucketFishEvent
extends PlayerEvent
implements Cancellable

This event is called whenever a player attempts to put a fish in a bucket.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor and Description
PlayerBucketFishEvent(@NotNull Player player, @NotNull Fish fish, @NotNull ItemStack waterBucket, @NotNull ItemStack fishBucket)

Method Summary

Modifier and Type	Method and Description
@NotNull Fish	getEntity() Gets the fish involved with this event.
@NotNull ItemStack	getFishBucket() Gets the bucket that the fish will be put into.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull ItemStack	getWaterBucket() Gets the bucket used.
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlayerBucketFishEvent

public PlayerBucketFishEvent(@NotNull
                             @NotNull Player player,
                             @NotNull
                             @NotNull Fish fish,
                             @NotNull
                             @NotNull ItemStack waterBucket,
                             @NotNull
                             @NotNull ItemStack fishBucket)

Method Detail

getEntity

@NotNull
public @NotNull Fish getEntity()

Gets the fish involved with this event.

Returns:

The fish involved with this event

getWaterBucket

@NotNull
public @NotNull ItemStack getWaterBucket()

Gets the bucket used. This refers to the bucket clicked with, ie Material.WATER_BUCKET.

Returns:

The used bucket

getFishBucket

@NotNull
public @NotNull ItemStack getFishBucket()

Gets the bucket that the fish will be put into. This refers to the bucket with the fish, ie Material.PUFFERFISH_BUCKET.

Returns:

The bucket that the fish will be put into

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()