Class PlayerItemFrameChangeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.PlayerItemFrameChangeEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class PlayerItemFrameChangeEvent
extends PlayerEvent
implements Cancellable

Called when an ItemFrame is having an item rotated, added, or removed from it.

Since:

1.18.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerItemFrameChangeEvent.ItemFrameChangeAction

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerItemFrameChangeEvent(Player player, ItemFrame itemFrame, ItemStack itemStack, PlayerItemFrameChangeEvent.ItemFrameChangeAction action)

Method Summary

Modifier and Type	Method	Description
PlayerItemFrameChangeEvent.ItemFrameChangeAction	getAction()	Gets the action that was performed on this ItemFrame.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemFrame	getItemFrame()	Gets the ItemFrame involved in this event.
ItemStack	getItemStack()	Gets the ItemStack involved in this event.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setItemStack(@Nullable ItemStack itemStack)	Sets the ItemStack that this ItemFrame holds.

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

PlayerItemFrameChangeEvent

@Internal
public PlayerItemFrameChangeEvent(Player player,
 ItemFrame itemFrame,
 ItemStack itemStack,
 PlayerItemFrameChangeEvent.ItemFrameChangeAction action)

Method Details

getItemFrame

public ItemFrame getItemFrame()

Gets the ItemFrame involved in this event.

Returns:

the ItemFrame

Since:

1.18.1

getItemStack

public ItemStack getItemStack()

Gets the ItemStack involved in this event. This is the item being added, rotated, or removed from the ItemFrame.

If this method returns air, then the resulting item in the ItemFrame will be empty.

Returns:

the ItemStack being added, rotated, or removed

Since:

1.18.1

setItemStack

public void setItemStack(@Nullable ItemStack itemStack)

Sets the ItemStack that this ItemFrame holds. If null is provided, the ItemStack will become air and the result in the ItemFrame will be empty.

Parameters:

itemStack - ItemFrame item

Since:

1.18.1

getAction

public PlayerItemFrameChangeEvent.ItemFrameChangeAction getAction()

Gets the action that was performed on this ItemFrame.

Returns:

action performed on the item frame in this event

Since:

1.18.1

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

Since:

1.18.1

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

Since:

1.18.1

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

Since:

1.18.1

getHandlerList

public static HandlerList getHandlerList()

Since:

1.18.1