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

@Experimental
@Deprecated(forRemoval=true)
public class PlayerSignOpenEvent
extends PlayerEvent
implements Cancellable

Deprecated, for removal: This API element is subject to removal in a future version.

use PlayerOpenSignEvent

This event is fired when a sign is opened by the player.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerSignOpenEvent.Cause	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

Constructors

Constructor	Description
PlayerSignOpenEvent(@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 Type	Method	Description
@NotNull PlayerSignOpenEvent.Cause	getCause()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the cause of the sign open.
static @NotNull HandlerList	getHandlerList()	Deprecated, for removal: This API element is subject to removal in a future version.
@NotNull HandlerList	getHandlers()	Deprecated, for removal: This API element is subject to removal in a future version.
@NotNull Side	getSide()	Deprecated, for removal: This API element is subject to removal in a future version. Gets side of the sign opened.
@NotNull Sign	getSign()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the sign that was opened.
boolean	isCancelled()	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

asynchronous, callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerSignOpenEvent

public PlayerSignOpenEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Sign sign,
 @NotNull
 @NotNull Side side,
 @NotNull
 @NotNull PlayerSignOpenEvent.Cause cause)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getSign

@NotNull
public @NotNull Sign 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

@NotNull
public @NotNull Side 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

@NotNull
public @NotNull PlayerSignOpenEvent.Cause 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 interface Cancellable

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

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

Deprecated, for removal: This API element is subject to removal in a future version.