Package io.papermc.paper.event.player

Class PlayerOpenSignEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.PlayerOpenSignEvent

All Implemented Interfaces:

Cancellable

public class PlayerOpenSignEvent
extends PlayerEvent
implements Cancellable

Called when a player begins editing a sign's text.

Cancelling this event stops the sign editing menu from opening.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerOpenSignEvent.Cause	The cause of the PlayerOpenSignEvent.

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
PlayerOpenSignEvent(@NotNull Player editor, @NotNull Sign sign, @NotNull Side side, @NotNull PlayerOpenSignEvent.Cause cause)

Method Summary

Modifier and Type	Method	Description
@NotNull PlayerOpenSignEvent.Cause	getCause()	The cause of this sign open.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Side	getSide()	Gets which side of the sign was clicked.
@NotNull Sign	getSign()	Gets the sign that was clicked.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

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

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerOpenSignEvent

@Internal
public PlayerOpenSignEvent(@NotNull
 @NotNull Player editor,
 @NotNull
 @NotNull Sign sign,
 @NotNull
 @NotNull Side side,
 @NotNull
 @NotNull PlayerOpenSignEvent.Cause cause)

Method Details

getSign

@NotNull
public @NotNull Sign getSign()

Gets the sign that was clicked.

Returns:

Sign that was clicked

getSide

@NotNull
public @NotNull Side getSide()

Gets which side of the sign was clicked.

Returns:

Side that was clicked

See Also:

• Sign.getSide(Side)

getCause

@NotNull
public @NotNull PlayerOpenSignEvent.Cause getCause()

The cause of this sign open.

Returns:

the cause

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

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()