Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.block.Sign Interface Reference
Inheritance diagram for org.bukkit.block.Sign:
org.bukkit.block.BlockState org.bukkit.metadata.Metadatable

Public Member Functions

String[] getLines ()
 
String getLine (int index) throws IndexOutOfBoundsException
 
void setLine (int index, String line) throws IndexOutOfBoundsException
 
- Public Member Functions inherited from org.bukkit.block.BlockState
Block getBlock ()
 
MaterialData getData ()
 
Material getType ()
 
int getTypeId ()
 
byte getLightLevel ()
 
World getWorld ()
 
int getX ()
 
int getY ()
 
int getZ ()
 
Location getLocation ()
 
Location getLocation (Location loc)
 
Chunk getChunk ()
 
void setData (MaterialData data)
 
void setType (Material type)
 
boolean setTypeId (int type)
 
boolean update ()
 
boolean update (boolean force)
 
boolean update (boolean force, boolean applyPhysics)
 
byte getRawData ()
 
void setRawData (byte data)
 

Detailed Description

Represents either a SignPost or a WallSign

Definition at line 6 of file block/Sign.java.

Member Function Documentation

String org.bukkit.block.Sign.getLine ( int  index) throws IndexOutOfBoundsException

Gets the line of text at the specified index.

For example, getLine(0) will return the first line of text.

Parameters
indexLine number to get the text from, starting at 0
Exceptions
IndexOutOfBoundsExceptionThrown when the line does not exist
Returns
Text on the given line
String [] org.bukkit.block.Sign.getLines ( )

Gets all the lines of text currently on this sign.

Returns
Array of Strings containing each line of text
void org.bukkit.block.Sign.setLine ( int  index,
String  line 
) throws IndexOutOfBoundsException

Sets the line of text at the specified index.

For example, setLine(0, "Line One") will set the first line of text to "Line One".

Parameters
indexLine number to set the text at, starting from 0
lineNew text to set at the specified index
Exceptions
IndexOutOfBoundsExceptionIf the index is out of the range 0..3

The documentation for this interface was generated from the following file: