More JavaDoc improvements.
This commit is contained in:
@@ -5,7 +5,9 @@ import org.bukkit.entity.Player;
|
||||
import org.bukkit.event.Cancellable;
|
||||
|
||||
/**
|
||||
* Called on sign change
|
||||
* Called when a sign is changed by a player.
|
||||
* <p />
|
||||
* If a Sign Change event is cancelled, the sign will not be changed.
|
||||
*/
|
||||
public class SignChangeEvent extends BlockEvent implements Cancellable {
|
||||
private boolean cancel = false;
|
||||
@@ -19,40 +21,40 @@ public class SignChangeEvent extends BlockEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the player for this event
|
||||
* Gets the player changing the sign involved in this event.
|
||||
*
|
||||
* @return Player player
|
||||
* @return The Player involved in this event.
|
||||
*/
|
||||
public Player getPlayer() {
|
||||
return player;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all of the text lines from this event
|
||||
* Gets all of the lines of text from the sign involved in this event.
|
||||
*
|
||||
* @return String[] of the event's text lines
|
||||
* @return A String[] of the sign's lines of text
|
||||
*/
|
||||
public String[] getLines() {
|
||||
return lines;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a single line from this event
|
||||
* Gets a single line of text from the sign involved in this event.
|
||||
*
|
||||
* @param index index of the line to get
|
||||
* @return String line
|
||||
* @throws IndexOutOfBoundsException
|
||||
* @return The String containing the line of text associated with the provided index
|
||||
* @throws IndexOutOfBoundsException thrown when the provided index is > 4 and < 0
|
||||
*/
|
||||
public String getLine(int index) throws IndexOutOfBoundsException {
|
||||
return lines[index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a single line for this event
|
||||
* Sets a single line for the sign involved in this event
|
||||
*
|
||||
* @param index index of the line to set
|
||||
* @param line text to set
|
||||
* @throws IndexOutOfBoundsException
|
||||
* @throws IndexOutOfBoundsException thrown when the provided index is > 4 and < 0
|
||||
*/
|
||||
public void setLine(int index, String line) throws IndexOutOfBoundsException {
|
||||
lines[index] = line;
|
||||
@@ -61,6 +63,8 @@ public class SignChangeEvent extends BlockEvent implements 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
|
||||
* <p />
|
||||
* If a Sign Change event is cancelled, the sign will not be changed.
|
||||
*
|
||||
* @return true if this event is cancelled
|
||||
*/
|
||||
@@ -71,6 +75,8 @@ public class SignChangeEvent extends BlockEvent implements 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
|
||||
* <p />
|
||||
* If a Sign Change event is cancelled, the sign will not be changed.
|
||||
*
|
||||
* @param cancel true if you wish to cancel this event
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user