net.risingworld.api.events.player

Class PlayerSetSignTextEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerSetSignTextEvent

All Implemented Interfaces:

Cancellable

public class PlayerSetSignTextEvent
extends PlayerEvent
implements Cancellable

Constructor Summary

Constructors

Constructor and Description
PlayerSetSignTextEvent(Player player, int signID, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
int	getLineColor(int line)
java.lang.String	getLineText(int line) Gets the content of a certain line (of the text the player wants to set for this sign).
int	getNumLines()
java.lang.String	getRawText() Gets the raw text the player wants to set for this sign, i.e. the text including color codes.
Sign	getSign() Gets the related sign object.
int	getSignID() Gets the related sign ID.
java.lang.String	getText() Gets the text the player wants to set for this sign.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setLine(int line, int color, java.lang.String text) Changes the text of a certain line.
void	setLine(int line, java.lang.String text) Changes a certain line of text the player wants to set for this sign (using default black color 0x000000).
void	setText(java.lang.String text) Sets a new text you want to be set for the sign.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerSetSignTextEvent

public PlayerSetSignTextEvent(Player player,
                              int signID,
                              java.lang.String text)

Method Detail

getText

public java.lang.String getText()

Gets the text the player wants to set for this sign. Note that the text returned by this function does not contain any color codes (to get the full text including color codes, see getRawText().

Returns:

the text the player wants to set.

getRawText

public java.lang.String getRawText()

Gets the raw text the player wants to set for this sign, i.e. the text including color codes.

Returns:

the raw text (i.e. including color codes) the player wants to set.

setText

public void setText(java.lang.String text)

Sets a new text you want to be set for the sign.

Parameters:

text - the text you want to set.

getNumLines

public int getNumLines()

getLineColor

public int getLineColor(int line)

getLineText

public java.lang.String getLineText(int line)

Gets the content of a certain line (of the text the player wants to set for this sign).

Parameters:

line - the line of the text. For example, to get the first line, provide 0, to get the second line, provide 1 etc.

Returns:

the text of the line, or an empty string if no text was set.

setLine

public void setLine(int line,
                    java.lang.String text)

Changes a certain line of text the player wants to set for this sign (using default black color 0x000000).

Parameters:

line - the line you want to change (0 for the first line, 1 for the 2nd line etc).

text - the text you want to set for this line. Provide an empty string to clear the line.

setLine

public void setLine(int line,
                    int color,
                    java.lang.String text)

Changes the text of a certain line.

Parameters:

line - the line you want to change (0 for the first line, 1 for the 2nd line etc).

color - the RGB color of the line (format: 0xRRGGBB, e.g. 0x000000 for black, 0xFF0000 for red, 0xFFFFFF for white etc).

text - the text you want to set for this line. Provide an empty string to clear the line.

getSignID

public int getSignID()

Gets the related sign ID.

Returns:

the ID of the sign the player wants to set the text for.

getSign

public Sign getSign()

Gets the related sign object.

Returns:

the sign object (the player wants to set the text for).

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.