Package net.minestom.server.event.player

Class PlayerChangeHeldSlotEvent

java.lang.Object

net.minestom.server.event.player.PlayerChangeHeldSlotEvent

All Implemented Interfaces:

Event, CancellableEvent, EntityEvent, EntityInstanceEvent, InstanceEvent, PlayerEvent, PlayerInstanceEvent

public class PlayerChangeHeldSlotEvent
extends Object
implements PlayerInstanceEvent, CancellableEvent

Called when a player change his held slot (by pressing 1-9 keys).

Constructor Summary

Constructors

Constructor	Description
PlayerChangeHeldSlotEvent(@NotNull Player player, byte oldSlot, byte newSlot)

Method Summary

Modifier and Type	Method	Description
ItemStack	getItemInNewSlot()	Gets the ItemStack in the slot the player will hold
ItemStack	getItemInOldSlot()	Gets the ItemStack in the player's currently held slot
byte	getNewSlot()	Gets the slot which the player will hold.
int	getOldSlot()	Gets the slot number that the player is currently holding
@NotNull Player	getPlayer()	Gets the player.
byte	getSlot()	Deprecated, for removal: This API element is subject to removal in a future version. Use getNewSlot() instead.
boolean	isCancelled()	Gets if the Event should be cancelled or not.
void	setCancelled(boolean cancel)	Marks the Event as cancelled or not.
void	setNewSlot(byte slot)	Changes the final held slot of the player.
void	setSlot(byte slot)	Deprecated, for removal: This API element is subject to removal in a future version. Use setNewSlot(byte) instead

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.event.trait.EntityInstanceEvent

getInstance

Methods inherited from interface net.minestom.server.event.trait.PlayerEvent

getEntity

Constructor Details

PlayerChangeHeldSlotEvent

public PlayerChangeHeldSlotEvent(@NotNull
 @NotNull Player player,
 byte oldSlot,
 byte newSlot)

Method Details

getSlot

@Deprecated(forRemoval=true)
public byte getSlot()

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

Use getNewSlot() instead.

Gets the slot which the player will hold.

Returns:

the future slot

getOldSlot

public int getOldSlot()

Gets the slot number that the player is currently holding

Returns:

The slot index that the player currently is holding

getNewSlot

public byte getNewSlot()

Gets the slot which the player will hold.

Returns:

the future slot

setSlot

@Deprecated(forRemoval=true)
public void setSlot(byte slot)

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

Use setNewSlot(byte) instead

Changes the final held slot of the player.

Parameters:

slot - the new held slot

Throws:

IllegalArgumentException - if slot is not between 0 and 8

setNewSlot

public void setNewSlot(byte slot)

Changes the final held slot of the player.

Parameters:

slot - the new held slot

Throws:

IllegalArgumentException - if slot is not between 0 and 8

getItemInOldSlot

public ItemStack getItemInOldSlot()

Gets the ItemStack in the player's currently held slot

Returns:

The ItemStack in the player's currently held slot

getItemInNewSlot

public ItemStack getItemInNewSlot()

Gets the ItemStack in the slot the player will hold

Returns:

The ItemStack in the final held slot of the player

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Gets if the Event should be cancelled or not.

Specified by:

isCancelled in interface CancellableEvent

Returns:

true if the event should be cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: CancellableEvent

Marks the Event as cancelled or not.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancel - true if the event should be cancelled, false otherwise

getPlayer

@NotNull
public @NotNull Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player