Package org.bukkit.block

Interface Sign

All Superinterfaces:
BlockState, Colorable, Metadatable, PersistentDataHolder, TileState
All Known Subinterfaces:
HangingSign
public interface Sign extends TileState, Colorable
Represents a captured state of either a SignPost or a WallSign.

  • Method Details

    • lines

      @NotNull List<Component> lines()
      Gets all the lines of text currently on the Side.FRONT of this sign.
      Returns:
      List of components containing each line of text
      See Also:

    • line

      @NotNull Component line(int index) throws IndexOutOfBoundsException
      Gets the line of text at the specified index on the Side.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
      See Also:

    • line

      void line(int index, @NotNull Component line) throws IndexOutOfBoundsException
      Sets the line of text at the specified index on the Side.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 0
      line - New text to set at the specified index
      Throws:
      IndexOutOfBoundsException - If the index is out of the range 0..3
      See Also:

    • getLines

      @NotNull @Deprecated @NotNull String[] getLines()
      Deprecated.
      Gets all the lines of text currently on the Side.FRONT of this sign.
      Returns:
      Array of Strings containing each line of text
      See Also:

    • getLine

      @NotNull @Deprecated @NotNull String getLine(int index) throws IndexOutOfBoundsException
      Deprecated.
      in favour of 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
      See Also:

    • setLine

      @Deprecated void setLine(int index, @NotNull @NotNull String line) throws IndexOutOfBoundsException
      Deprecated.
      in favour of 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 0
      line - New text to set at the specified index
      Throws:
      IndexOutOfBoundsException - If the index is out of the range 0..3
      See Also:

    • isEditable

      boolean isEditable()
      Marks whether this sign can be edited by players.
      This is a special value, which is not persisted. It should only be set if a placed sign is manipulated during the BlockPlaceEvent. Behaviour outside of this event is undefined.
      Returns:
      if this sign is currently editable

    • setEditable

      void setEditable(boolean editable)
      Marks whether this sign can be edited by players.
      This is a special value, which is not persisted. It should only be set if a placed sign is manipulated during the BlockPlaceEvent. Behaviour outside of this event is undefined.
      Parameters:
      editable - if this sign is currently editable

    • isGlowingText

      boolean isGlowingText()
      Gets whether this sign has glowing text. Only affects the Side.FRONT.
      Returns:
      if this sign has glowing text
      See Also:

    • setGlowingText

      void setGlowingText(boolean glowing)
      Sets whether this sign has glowing text. Only affects the Side.FRONT.
      Parameters:
      glowing - if this sign has glowing text
      See Also:

    • getColor

      @NotNull @NotNull DyeColor 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).
      Specified by:
      getColor in interface Colorable
      Returns:
      The DyeColor of this object.
      See Also:

    • setColor

      void setColor(@NotNull @NotNull DyeColor color)
      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).
      Specified by:
      setColor in interface Colorable
      Parameters:
      color - The color of the object, as a DyeColor.
      See Also:

    • getSide

      @Experimental @NotNull @NotNull SignSide getSide(@NotNull @NotNull Side side)
      Return the side of the sign.
      Parameters:
      side - the side of the sign
      Returns:
      the selected side of the sign