Class PlayerShearEntityEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerShearEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerShearEntityEvent
extends PlayerEvent
implements Cancellable

Called when a player shears an entity

Since:

1.1.0

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerShearEntityEvent(@NotNull Player player, @NotNull Entity entity)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerShearEntityEvent(@NotNull Player player, @NotNull Entity entity, @NotNull ItemStack item, @NotNull EquipmentSlot hand, @NotNull List<ItemStack> drops)

Method Summary

Modifier and Type	Method	Description
@NotNull @Unmodifiable List<ItemStack>	getDrops()	Get an immutable list of drops for this shearing.
@NotNull Entity	getEntity()	Gets the entity the player is shearing
@NotNull EquipmentSlot	getHand()	Gets the hand used to shear the entity.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull ItemStack	getItem()	Gets the item used to shear the entity.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setDrops(@NotNull List<ItemStack> drops)	Sets the drops for the shearing.

Methods inherited from class PlayerEvent

getPlayer

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

PlayerShearEntityEvent

@Internal
public PlayerShearEntityEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull ItemStack item,
 @NotNull
 @NotNull EquipmentSlot hand,
 @NotNull
 @NotNull List<ItemStack> drops)

PlayerShearEntityEvent

@Internal
@Deprecated(since="1.15.2",
            forRemoval=true)
public PlayerShearEntityEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Entity entity)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getEntity

@NotNull
public @NotNull Entity getEntity()

Gets the entity the player is shearing

Returns:

the entity the player is shearing

Since:

1.1.0

getItem

@NotNull
public @NotNull ItemStack getItem()

Gets the item used to shear the entity.

Returns:

the shears

Since:

1.15.2

getHand

@NotNull
public @NotNull EquipmentSlot getHand()

Gets the hand used to shear the entity.

Returns:

the hand

Since:

1.15.2

getDrops

@NotNull
public @NotNull @Unmodifiable List<ItemStack> getDrops()

Get an immutable list of drops for this shearing.

Returns:

the shearing drops

Since:

1.20.4

See Also:

• setDrops(java.util.List)

setDrops

public void setDrops(@NotNull
 @NotNull List<ItemStack> drops)

Sets the drops for the shearing.

Parameters:

drops - the shear drops

Since:

1.20.4

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

Since:

1.1.0

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

Since:

1.1.0

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

Since:

1.1.0

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

Since:

1.1.0