Package io.github.thebusybiscuit.slimefun4.api.events

Class PlayerRightClickEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.github.thebusybiscuit.slimefun4.api.events.PlayerRightClickEvent

public class PlayerRightClickEvent
extends PlayerEvent

The PlayerRightClickEvent is our custom version of the PlayerInteractEvent. But it is only triggered on right click. The main and (almost) sole purpose of this Event is to cache the SlimefunItem of the ItemStack and/or Block involved. This allows us (and addons) to efficiently check the used SlimefunItem without the need to do a heavy lookup or item comparison.

Author:

TheBusyBiscuit

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	Description
PlayerRightClickEvent(PlayerInteractEvent originalEvent)	This constructs a new PlayerRightClickEvent based on the original PlayerInteractEvent.

Method Summary

Modifier and Type	Method	Description
void	cancel()	This method cancels the PlayerRightClickEvent.
Optional<Block>	getClickedBlock()
BlockFace	getClickedFace()
EquipmentSlot	getHand()	This returns the hand that was used in this interaction.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
PlayerInteractEvent	getInteractEvent()	This returns the original PlayerInteractEvent that triggered this PlayerRightClickEvent.
ItemStack	getItem()	This method returns the ItemStack that was held in the hand of the Player.
Optional<SlimefunItem>	getSlimefunBlock()
Optional<SlimefunItem>	getSlimefunItem()
void	setUseBlock(Event.Result result)
void	setUseItem(Event.Result result)
Event.Result	useBlock()
Event.Result	useItem()

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

getPlayer

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerRightClickEvent

public PlayerRightClickEvent(@Nonnull
 PlayerInteractEvent originalEvent)

This constructs a new PlayerRightClickEvent based on the original PlayerInteractEvent. The Event.Result of the original PlayerInteractEvent will be copied.

Parameters:

originalEvent - The original PlayerInteractEvent

Method Details

getInteractEvent

@Nonnull
public PlayerInteractEvent getInteractEvent()

This returns the original PlayerInteractEvent that triggered this PlayerRightClickEvent.

Returns:

The original PlayerInteractEvent

getItem

@Nonnull
public ItemStack getItem()

This method returns the ItemStack that was held in the hand of the Player. It will never return null, should there be no ItemStack then it will return new ItemStack(Material.AIR).

Returns:

The ItemStack that the Player right clicked with

getHand

@Nonnull
public EquipmentSlot getHand()

This returns the hand that was used in this interaction. Can either be EquipmentSlot.HAND or EquipmentSlot.OFF_HAND.

Returns:

The hand used in this Event

getClickedBlock

@Nonnull
public Optional<Block> getClickedBlock()

getClickedFace

@Nonnull
public BlockFace getClickedFace()

getSlimefunItem

@Nonnull
public Optional<SlimefunItem> getSlimefunItem()

getSlimefunBlock

@Nonnull
public Optional<SlimefunItem> getSlimefunBlock()

cancel

public void cancel()

This method cancels the PlayerRightClickEvent. This will deny the item and block usage.

useItem

@Nonnull
public Event.Result useItem()

useBlock

@Nonnull
public Event.Result useBlock()

setUseItem

public void setUseItem(@Nonnull
 Event.Result result)

setUseBlock

public void setUseBlock(@Nonnull
 Event.Result result)

getHandlerList

@Nonnull
public static HandlerList getHandlerList()

getHandlers

@Nonnull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event