Package org.bukkit.block.sign
Interface SignSide
- All Superinterfaces:
Colorable
Represents a side of a sign.
-
Method Summary
Modifier and TypeMethodDescriptiongetLine
(int index) Deprecated.getLines()
Deprecated.in favour oflines()
boolean
Gets whether this side of the sign has glowing text.line
(int index) Gets the line of text at the specified index.void
Sets the line of text at the specified index.lines()
Gets all the lines of text currently on the sign.void
setGlowingText
(boolean glowing) Sets whether this side of the sign has glowing text.void
Deprecated.in favour ofline(int, net.kyori.adventure.text.Component)
-
Method Details
-
lines
Gets all the lines of text currently on the sign.- Returns:
- List of components containing each line of text
-
line
Gets the line of text at the specified index.For example, getLine(0) will return the first line of text.
- Parameters:
index
- Line number to get the text from, starting at 0- Returns:
- Text on the given line
- Throws:
IndexOutOfBoundsException
- Thrown when the line does not exist
-
line
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:
index
- Line number to set the text at, starting from 0line
- New text to set at the specified index- Throws:
IndexOutOfBoundsException
- If the index is out of the range 0..3
-
getLines
Deprecated.in favour oflines()
Gets all the lines of text currently on this side of the sign.- Returns:
- Array of Strings containing each line of text
-
getLine
Deprecated.in favour ofline(int)
Gets the line of text at the specified index on this side of the sign.For example, getLine(0) will return the first line of text.
- Parameters:
index
- Line number to get the text from, starting at 0- Returns:
- Text on the given line
- Throws:
IndexOutOfBoundsException
- Thrown when the line does not exist
-
setLine
Deprecated.in favour ofline(int, net.kyori.adventure.text.Component)
Sets the line of text at the specified index on this side of the sign.For example, setLine(0, "Line One") will set the first line of text to "Line One".
- Parameters:
index
- Line number to set the text at, starting from 0line
- New text to set at the specified index- Throws:
IndexOutOfBoundsException
- If the index is out of the range 0..3
-
isGlowingText
boolean isGlowingText()Gets whether this side of the sign has glowing text.- Returns:
- if this side of the sign has glowing text
-
setGlowingText
void setGlowingText(boolean glowing) Sets whether this side of the sign has glowing text.- Parameters:
glowing
- if this side of the sign has glowing text
-
line(int)