Class PlayerSwapWithEquipmentSlotEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.PlayerSwapWithEquipmentSlotEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class PlayerSwapWithEquipmentSlotEvent
extends PlayerEvent
implements Cancellable

Triggered when a Player swaps an item with an equipment slot.

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
PlayerSwapWithEquipmentSlotEvent(Player player, ItemStack itemInHand, EquipmentSlot slot, ItemStack itemToSwap)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemStack	getItemInHand()	Returns the item in one of the hand slots.
ItemStack	getItemToSwap()	Returns the item to swap.
EquipmentSlot	getSlot()	Returns the slot to swap into.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

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

PlayerSwapWithEquipmentSlotEvent

@Internal
public PlayerSwapWithEquipmentSlotEvent(Player player,
 ItemStack itemInHand,
 EquipmentSlot slot,
 ItemStack itemToSwap)

Method Details

getItemInHand

public ItemStack getItemInHand()

Returns the item in one of the hand slots.

Returns:

the item in one of the hand slots

getSlot

public EquipmentSlot getSlot()

Returns the slot to swap into.

Returns:

the slot to swap into

getItemToSwap

public ItemStack getItemToSwap()

Returns the item to swap.

Returns:

the item to swap

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 cancelled)

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:

cancelled - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()