Class PlayerItemHeldEvent

java.lang.Object

fr.fidorial.event.player.PlayerItemHeldEvent

All Implemented Interfaces:

Cancellable, Event, PlayerEvent

public final class PlayerItemHeldEvent
extends Object
implements PlayerEvent, Cancellable

Fired when a player selects another hotbar slot, with the number keys or the mouse wheel.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
PlayerItemHeldEvent(Player player, int previousSlot, int newSlot)	Creates an event.

Method Summary

Modifier and Type	Method	Description
boolean	isCancelled()	Returns true if the action this event describes will not happen.
int	newSlot()	Returns the hotbar slot the player selects, 0-8.
Player	player()	Returns the player involved in this event.
int	previousSlot()	Returns the hotbar slot selected before, 0-8.
void	setCancelled(boolean cancelled)	Prevents or re-allows the action this event describes.

Methods inherited from class Object

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

Constructor Details

PlayerItemHeldEvent

public PlayerItemHeldEvent(Player player,
 int previousSlot,
 int newSlot)

Creates an event.

Parameters:

player - the player

previousSlot - the slot selected before, 0-8

newSlot - the slot selected now, 0-8

Since:

0.1.0

Method Details

player

public Player player()

Description copied from interface: PlayerEvent

Returns the player involved in this event.

Specified by:

player in interface PlayerEvent

Returns:

the player involved in this event

previousSlot

public int previousSlot()

Returns the hotbar slot selected before, 0-8.

Returns:

the hotbar slot selected before, 0-8

Since:

0.1.0

newSlot

public int newSlot()

Returns the hotbar slot the player selects, 0-8.

Returns:

the hotbar slot the player selects, 0-8

Since:

0.1.0

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Returns true if the action this event describes will not happen.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the action this event describes will not happen

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: Cancellable

Prevents or re-allows the action this event describes.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancelled - true to prevent it