net.tridentsdk.event.block

Class SignChangeEvent

java.lang.Object

net.tridentsdk.event.Event

net.tridentsdk.event.block.BlockEvent

net.tridentsdk.event.block.SignChangeEvent

All Implemented Interfaces:

Cancellable

public class SignChangeEvent
extends BlockEvent
implements Cancellable

Called when a player edits a sign, or when the sign is first created

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
SignChangeEvent(Block block, Player editor, String... contents)

Method Summary

Modifier and Type	Method and Description
void	cancel(boolean cancelled)
String[]	contents() Returns the contents of the Sign
Player	editor() Returns the Player who edited the Sign
boolean	isIgnored()
String	line(int i) Returns the text of the specified line
void	setContents(String... contents) Sets the contents of the Sign
String	setLine(int i, String text) Sets the value of a line

Methods inherited from class net.tridentsdk.event.block.BlockEvent

block

Methods inherited from class java.lang.Object

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

Constructor Detail

SignChangeEvent

public SignChangeEvent(Block block,
                       Player editor,
                       String... contents)

Method Detail

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface Cancellable

Returns:

return true if event is set to cancelled

cancel

public void cancel(boolean cancelled)

Specified by:

cancel in interface Cancellable

Parameters:

cancelled - set the cancellation state of the event

contents

public String[] contents()

Returns the contents of the Sign

Returns:

String[] contents of the Sign

setContents

public void setContents(String... contents)

Sets the contents of the Sign

Parameters:

contents - String[] contents of the Sign

line

public String line(int i)

Returns the text of the specified line

Parameters:

i - line of the Sign

Returns:

String text of the specified line

setLine

public String setLine(int i,
                      String text)

Sets the value of a line

Parameters:

i - line of the Sign

text - String text to set the line as

Returns:

String previous text on the specified line

editor

public Player editor()

Returns the Player who edited the Sign

Returns:

Player editor of the sign, null if no player