Class SulfurCubeSwallowItemEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

io.papermc.paper.event.entity.SulfurCubeSwallowItemEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class SulfurCubeSwallowItemEvent
extends EntityEvent
implements Cancellable

Called when a SulfurCube swallows an item.

If the ItemStack is modified, the SulfurCube will swallow the new item and not remove the original one from the player's inventory.

If the event is cancelled, the SulfurCube will not swallow the item, and it will not be removed from the player's inventory.

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
SulfurCubeSwallowItemEvent(SulfurCube sulfurCube, Player player, ItemStack oldItem, ItemStack newItem)

Method Summary

Modifier and Type	Method	Description
SulfurCube	getEntity()	Returns the Entity involved in this event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemStack	getNewItem()	Gets the item that is being swallowed.
ItemStack	getOldItem()	Gets the item that is currently swallowed by the SulfurCube.
Player	getPlayer()	Gets the player interacting with the SulfurCube.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setNewItem(ItemStack newItem)	Set the item being swallowed.

Methods inherited from class EntityEvent

getEntityType

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

SulfurCubeSwallowItemEvent

@Internal
public SulfurCubeSwallowItemEvent(SulfurCube sulfurCube,
 Player player,
 ItemStack oldItem,
 ItemStack newItem)

Method Details

getPlayer

public Player getPlayer()

Gets the player interacting with the SulfurCube.

Returns:

the player that interacted with the SulfurCube

getOldItem

public ItemStack getOldItem()

Gets the item that is currently swallowed by the SulfurCube.

Returns:

an ItemStack for the item currently swallowed

getNewItem

public ItemStack getNewItem()

Gets the item that is being swallowed. Modifying the returned item will have no effect, you must use setNewItem(org.bukkit.inventory.ItemStack) instead.

Returns:

an ItemStack for the item being swallowed

setNewItem

public void setNewItem(ItemStack newItem)

Set the item being swallowed.

Parameters:

newItem - the item being swallowed

getEntity

public SulfurCube getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

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

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()