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

public class PlayerSignOpenEvent
extends PlayerEvent
implements Cancellable

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

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(Player player, Sign sign, Side side, PlayerSignOpenEvent.Cause cause)

Method Summary

Modifier and Type	Method	Description
PlayerSignOpenEvent.Cause	getCause()	Gets the cause of the sign open.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Side	getSide()	Gets side of the sign opened.
Sign	getSign()	Gets the sign that was opened.
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

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

Method Details

getSign

@NotNull
public Sign getSign()

Gets the sign that was opened.

Returns:

opened sign

getSide

@NotNull
public Side getSide()

Gets side of the sign opened.

Returns:

side of sign opened

getCause

@NotNull
public PlayerSignOpenEvent.Cause getCause()

Gets the cause of the sign open.

Returns:

sign open 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 HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()