Package org.bukkit.event.player
Class PlayerSignOpenEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerSignOpenEvent
- All Implemented Interfaces:
Cancellable
@Deprecated(forRemoval=true)
public class PlayerSignOpenEvent
extends PlayerEvent
implements Cancellable
Deprecated, for removal: This API element is subject to removal in a future version.
This event is fired when a sign is opened by the player.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Deprecated, for removal: This API element is subject to removal in a future version.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
ConstructorDescriptionPlayerSignOpenEvent
(@NotNull Player player, @NotNull Sign sign, @NotNull Side side, @NotNull PlayerSignOpenEvent.Cause cause) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the cause of the sign open.static @NotNull HandlerList
Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.getSide()
Deprecated, for removal: This API element is subject to removal in a future version.Gets side of the sign opened.getSign()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the sign that was opened.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Deprecated, for removal: This API element is subject to removal in a future version.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
-
Constructor Details
-
Method Details
-
getSign
Deprecated, for removal: This API element is subject to removal in a future version.Gets the sign that was opened.- Returns:
- opened sign
-
getSide
Deprecated, for removal: This API element is subject to removal in a future version.Gets side of the sign opened.- Returns:
- side of sign opened
-
getCause
Deprecated, for removal: This API element is subject to removal in a future version.Gets the cause of the sign open.- Returns:
- sign open cause
-
isCancelled
public boolean isCancelled()Deprecated, for removal: This API element is subject to removal in a future version.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 interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Deprecated, for removal: This API element is subject to removal in a future version.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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
getHandlers
in classEvent
-
getHandlerList
Deprecated, for removal: This API element is subject to removal in a future version.
-
PlayerOpenSignEvent