Package com.tomkeuper.bedwars.api.hologram.containers

Interface IHologram

public interface IHologram

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addLine(IHoloLine line)
    Add a line to the hologram.
    void
    addLine(IHoloLine line, boolean update)
    Add a line to the hologram.
    void
    addLine(String line)
    Add a line to the hologram.
    void
    addLine(String line, boolean update)
    Add a line to the hologram.
    void
    clearLines()
    Clear all lines from the hologram.
    void
    clearLines(boolean update)
    Clear all lines from the hologram.
    double
    getGap()
    Get the gap between the lines.
    IHoloLine
    getLine(int index)
    Get a line from the hologram.
    List<IHoloLine>
    getLines()
    Get all lines from the hologram.
    org.bukkit.Location
    getLocation()
    Get the location of the hologram.
    org.bukkit.entity.Player
    getPlayer()
    Get the player this hologram is bounded to.
    void
    hide()
    Hide the hologram.
    void
    insertLine(int index, IHoloLine line)
    Insert a line to the hologram.
    void
    insertLine(int index, IHoloLine line, boolean update)
    Insert a line to the hologram.
    void
    insertLine(int index, String line)
    Insert a line to the hologram.
    void
    insertLine(int index, String line, boolean update)
    Insert a line to the hologram.
    boolean
    isShowing()
    Check if the hologram is showing.
    void
    remove()
    Remove the hologram.
    void
    removeLine(int index)
    Remove a line from the hologram.
    void
    removeLine(int index, boolean update)
    Remove a line from the hologram.
    void
    removeLine(IHoloLine line)
    Remove a line from the hologram.
    void
    removeLine(IHoloLine line, boolean update)
    Remove a line from the hologram.
    void
    removeLineContaining(String text)
    Removes a line from the hologram that contains the specified text.
    void
    setGap(double gap)
    Set the gap between the lines.
    void
    setGap(double gap, boolean update)
    Set the gap between the lines.
    void
    setLine(int index, IHoloLine line)
    Set a line of the hologram.
    void
    setLine(int index, IHoloLine line, boolean update)
    Set a line of the hologram.
    void
    setLine(int index, String line)
    Set a line of the hologram.
    void
    setLine(int index, String line, boolean update)
    Set a line of the hologram.
    void
    setLines(String[] lines, boolean update)
    Set the hologram lines.
    void
    setLines(List<IHoloLine> lines, boolean update)
    Set the hologram lines.
    void
    show()
    Show the hologram.
    int
    size()
    Get the size of the hologram.
    void
    update()
    Update the hologram.

  • Method Details

    • getPlayer

      org.bukkit.entity.Player getPlayer()
      Get the player this hologram is bounded to.
      Returns:
      the player

    • addLine

      void addLine(IHoloLine line)
      Add a line to the hologram.
      Parameters:
      line - - the line you want to add

    • removeLine

      void removeLine(IHoloLine line)
      Remove a line from the hologram.
      Parameters:
      line - - the line you want to remove

    • removeLine

      void removeLine(int index)
      Remove a line from the hologram.
      Parameters:
      index - - the index of the line you want to remove

    • removeLineContaining

      void removeLineContaining(String text)
      Removes a line from the hologram that contains the specified text.
      Parameters:
      text - the text to search for within the lines of the hologram. If a line contains this text, it will be removed.

    • clearLines

      void clearLines()
      Clear all lines from the hologram.

    • update

      void update()
      Update the hologram.

    • show

      void show()
      Show the hologram.

    • hide

      void hide()
      Hide the hologram.

    • isShowing

      boolean isShowing()
      Check if the hologram is showing.
      Returns:
      true if the hologram is showing

    • size

      int size()
      Get the size of the hologram.
      Returns:
      the size

    • getLine

      IHoloLine getLine(int index)
      Get a line from the hologram.
      Parameters:
      index - - the index of the line
      Returns:
      the line

    • getLines

      List<IHoloLine> getLines()
      Get all lines from the hologram.
      Returns:
      the lines

    • getLocation

      org.bukkit.Location getLocation()
      Get the location of the hologram.
      Returns:
      the location

    • setLines

      void setLines(String[] lines, boolean update)
      Set the hologram lines.
      Parameters:
      lines - - the lines
      update - - if the hologram should be updated

    • setLines

      void setLines(List<IHoloLine> lines, boolean update)
      Set the hologram lines.
      Parameters:
      lines - - the lines
      update - - if the hologram should be updated

    • setLine

      void setLine(int index, IHoloLine line)
      Set a line of the hologram.
      Parameters:
      index - - the index of the line
      line - - the line

    • setLine

      void setLine(int index, IHoloLine line, boolean update)
      Set a line of the hologram.
      Parameters:
      index - - the index of the line
      line - - the line
      update - - if the hologram should be updated

    • setLine

      void setLine(int index, String line)
      Set a line of the hologram.
      Parameters:
      index - - the index of the line
      line - - the line

    • setLine

      void setLine(int index, String line, boolean update)
      Set a line of the hologram.
      Parameters:
      index - - the index of the line
      line - - the line
      update - - if the hologram should be updated

    • insertLine

      void insertLine(int index, IHoloLine line)
      Insert a line to the hologram.
      Parameters:
      index - - the index of the line
      line - - the line

    • insertLine

      void insertLine(int index, IHoloLine line, boolean update)
      Insert a line to the hologram.
      Parameters:
      index - - the index of the line
      line - - the line
      update - - if the hologram should be updated

    • insertLine

      void insertLine(int index, String line)
      Insert a line to the hologram.
      Parameters:
      index - - the index of the line
      line - - the line

    • insertLine

      void insertLine(int index, String line, boolean update)
      Insert a line to the hologram.
      Parameters:
      index - - the index of the line
      line - - the line
      update - - if the hologram should be updated

    • addLine

      void addLine(IHoloLine line, boolean update)
      Add a line to the hologram.
      Parameters:
      line - - the line

    • addLine

      void addLine(String line)
      Add a line to the hologram.
      Parameters:
      line - - the line

    • addLine

      void addLine(String line, boolean update)
      Add a line to the hologram.
      Parameters:
      line - - the line
      update - - if the hologram should be updated

    • removeLine

      void removeLine(IHoloLine line, boolean update)
      Remove a line from the hologram.
      Parameters:
      line - - the line
      update - - if the hologram should be updated

    • removeLine

      void removeLine(int index, boolean update)
      Remove a line from the hologram.
      Parameters:
      index - - the index of the line
      update - - if the hologram should be updated

    • clearLines

      void clearLines(boolean update)
      Clear all lines from the hologram.
      Parameters:
      update - - if the hologram should be updated

    • setGap

      void setGap(double gap)
      Set the gap between the lines.
      Parameters:
      gap - - the gap

    • setGap

      void setGap(double gap, boolean update)
      Set the gap between the lines.
      Parameters:
      gap - - the gap
      update - - if the hologram should be updated

    • getGap

      double getGap()
      Get the gap between the lines.

    • remove

      void remove()
      Remove the hologram.