Package io.papermc.paper.event.packet

Class UncheckedSignChangeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.packet.UncheckedSignChangeEvent

All Implemented Interfaces:

Cancellable

@NullMarked
@Experimental
public class UncheckedSignChangeEvent
extends PlayerEvent
implements Cancellable

Called when a client attempts to modify a sign, but the location at which the sign should be edited has not yet been checked for the existence of a real sign.

Cancelling this event will prevent further processing of the sign change, but needs further handling by the plugin as the client's local world might be in an inconsistent state.

See Also:

• Player.openVirtualSign(Position, Side)

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
UncheckedSignChangeEvent(Player editor, BlockPosition editedBlockPosition, Side side, List<Component> lines)

Method Summary

Modifier and Type	Method	Description
BlockPosition	getEditedBlockPosition()	Gets the location at which a potential sign was edited.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Side	getSide()	Gets which side of the sign was edited.
boolean	isCancelled()	Gets the cancellation state of this event.
@Unmodifiable List<Component>	lines()	Gets the lines that the player has entered.
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

UncheckedSignChangeEvent

@Internal
public UncheckedSignChangeEvent(Player editor,
 BlockPosition editedBlockPosition,
 Side side,
 List<Component> lines)

Method Details

getEditedBlockPosition

public BlockPosition getEditedBlockPosition()

Gets the location at which a potential sign was edited.

Returns:

location where the change happened

getSide

public Side getSide()

Gets which side of the sign was edited.

Returns:

Side that was edited

lines

public @Unmodifiable List<Component> lines()

Gets the lines that the player has entered.

Returns:

the lines

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