Package org.bukkit.block
Interface Sign
- All Superinterfaces:
BlockState
,Colorable
,Metadatable
,PersistentDataHolder
,PersistentDataViewHolder
,TileState
- All Known Subinterfaces:
HangingSign
Represents a captured state of either a SignPost or a WallSign.
-
Method Summary
Modifier and TypeMethodDescriptionGets the player that is currently allowed to edit this sign.Gets the allowed editor's UUID.getColor()
Deprecated.A sign may have multiple writable sides now.getInteractableSideFor
(double x, double z) Compute the side facing the specific x and z coordinates.getInteractableSideFor
(@NotNull Position position) Compute the side facing the specific position.getInteractableSideFor
(@NotNull Entity entity) Compute the side facing the specified entity.getLine
(int index) Deprecated.A sign may have multiple writable sides now.getLines()
Deprecated.A sign may have multiple writable sides now.Return the side of the sign.getTargetSide
(@NotNull Player player) Gets the side of this sign the given player is currently standing on.boolean
Deprecated.useisWaxed()
insteadboolean
Deprecated.A sign may have multiple writable sides now.boolean
isWaxed()
Gets whether or not this sign has been waxed.line
(int index) Deprecated.A sign may have multiple writable sides now.void
Deprecated.A sign may have multiple writable sides now.lines()
Deprecated.A sign may have multiple writable sides now.void
setAllowedEditorUniqueId
(UUID uuid) Sets the allowed editor's UUID.void
Deprecated.A sign may have multiple writable sides now.void
setEditable
(boolean editable) Deprecated.usesetWaxed(boolean)
insteadvoid
setGlowingText
(boolean glowing) Deprecated.A sign may have multiple writable sides now.void
Deprecated.A sign may have multiple writable sides now.void
setWaxed
(boolean waxed) Sets whether or not this sign has been waxed.Methods inherited from interface org.bukkit.block.BlockState
copy, copy, getBlock, getBlockData, getChunk, getData, getDrops, getDrops, getDrops, getLightLevel, getLocation, getLocation, getRawData, getType, getWorld, getX, getY, getZ, isCollidable, isPlaced, setBlockData, setData, setRawData, setType, update, update, update
Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata
Methods inherited from interface org.bukkit.block.TileState
getPersistentDataContainer, isSnapshot
-
Method Details
-
lines
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.lines()
.Gets all the lines of text currently on theSide.FRONT
of this sign.- Returns:
- List of components containing each line of text
-
line
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.line(int)
.Gets the line of text at the specified index on theSide.FRONT
.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
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.line(int, net.kyori.adventure.text.Component)
.Sets the line of text at the specified index on theSide.FRONT
.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.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.lines()
.Gets all the lines of text currently on theSide.FRONT
of this sign.- Returns:
- Array of Strings containing each line of text
-
getLine
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.line(int)
.Gets the line of text at the specified index.For example, getLine(0) will return the first line of text on the
Side.FRONT
.- 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.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.line(int, net.kyori.adventure.text.Component)
.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
-
isEditable
Deprecated.useisWaxed()
insteadMarks whether this sign can be edited by players.- Returns:
- if this sign is currently editable
-
setEditable
Deprecated.usesetWaxed(boolean)
insteadMarks whether this sign can be edited by players.- Parameters:
editable
- if this sign is currently editable
-
isWaxed
boolean isWaxed()Gets whether or not this sign has been waxed. If a sign has been waxed, it cannot be edited by a player.- Returns:
- if this sign is waxed
-
setWaxed
void setWaxed(boolean waxed) Sets whether or not this sign has been waxed. If a sign has been waxed, it cannot be edited by a player.- Parameters:
waxed
- if this sign is waxed
-
isGlowingText
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.isGlowingText()
.Gets whether this sign has glowing text. Only affects theSide.FRONT
.- Returns:
- if this sign has glowing text
-
setGlowingText
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andSignSide.setGlowingText(boolean)
.Sets whether this sign has glowing text. Only affects theSide.FRONT
.- Parameters:
glowing
- if this sign has glowing text
-
getColor
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andColorable.getColor()
.Gets the color of this object.
This may be null to represent the default color of an object, if the object has a special default color (e.g Shulkers). -
setColor
Deprecated.A sign may have multiple writable sides now. UsegetSide(Side)
andColorable.setColor(org.bukkit.DyeColor)
.Sets the color of this object to the specified DyeColor.
This may be null to represent the default color of an object, if the object has a special default color (e.g Shulkers). -
getSide
Return the side of the sign.- Parameters:
side
- the side of the sign- Returns:
- the selected side of the sign
-
getTargetSide
Gets the side of this sign the given player is currently standing on.- Parameters:
player
- the player- Returns:
- the side the player is standing on
-
getAllowedEditor
Gets the player that is currently allowed to edit this sign.
Edits from other players will be rejected if this value is not null.
You should prefergetAllowedEditorUniqueId()
if you don't need the player instance as this method will fetch the player from UUID.- Returns:
- the player allowed to edit this sign, or null
-
getAllowedEditorUniqueId
Gets the allowed editor's UUID.
Edits from other players will be rejected if this value is not null.- Returns:
- the allowed editor's UUID, or null
-
setAllowedEditorUniqueId
Sets the allowed editor's UUID.
Note: the server sets the UUID back to null if the player can't interact with the sign (is either offline or outside the allowed interaction range).- Parameters:
uuid
- the allowed editor's UUID
-
getInteractableSideFor
Compute the side facing the specified entity.- Parameters:
entity
- the entity- Returns:
- the side it is facing
-
getInteractableSideFor
Compute the side facing the specific position.- Parameters:
position
- the position- Returns:
- the side the position is facing
-
getInteractableSideFor
Compute the side facing the specific x and z coordinates.- Parameters:
x
- the x coordz
- the z coord- Returns:
- the side the coordinates are facing
-