Package io.github.projectunified.unihologram.spigot.fancyholograms

Class FHHologram

java.lang.Object
io.github.projectunified.unihologram.spigot.fancyholograms.FHHologram
All Implemented Interfaces:
DisplayHologram<org.bukkit.Location>, Hologram<org.bukkit.Location>, Visibility<org.bukkit.entity.Player>, PlayerVisibility
public class FHHologram extends Object implements PlayerVisibility, DisplayHologram<org.bukkit.Location>
The hologram for FancyHolograms

  • Constructor Details

    • FHHologram

      public FHHologram(String name, org.bukkit.Location location)
      Create a new hologram
      Parameters:
      name - the name of the hologram
      location - the location of the hologram

    • FHHologram

      public FHHologram(de.oliver.fancyholograms.api.hologram.Hologram hologram)
      Create a new hologram
      Parameters:
      hologram - the hologram

  • Method Details

    • getLines

      @NotNull public @NotNull List<HologramLine> getLines()
      Description copied from interface: Hologram
      Get the lines of the hologram
      Specified by:
      getLines in interface Hologram<org.bukkit.Location>
      Returns:
      the lines

    • setLines

      public void setLines(@NotNull @NotNull List<HologramLine> lines)
      Description copied from interface: Hologram
      Set the lines of the hologram
      Specified by:
      setLines in interface Hologram<org.bukkit.Location>
      Parameters:
      lines - the lines

    • addLine

      public void addLine(@NotNull @NotNull HologramLine line)
      Description copied from interface: Hologram
      Add a line to the hologram
      Specified by:
      addLine in interface Hologram<org.bukkit.Location>
      Parameters:
      line - the line

    • insertLine

      public void insertLine(int index, @NotNull @NotNull HologramLine line)
      Description copied from interface: Hologram
      Insert a line to the hologram at the index and move the rest down
      Specified by:
      insertLine in interface Hologram<org.bukkit.Location>
      Parameters:
      index - the index
      line - the line

    • removeLine

      public void removeLine(int index)
      Description copied from interface: Hologram
      Remove a line at the index from the hologram
      Specified by:
      removeLine in interface Hologram<org.bukkit.Location>
      Parameters:
      index - the index

    • getName

      public String getName()
      Description copied from interface: Hologram
      Get the name of the hologram
      Specified by:
      getName in interface Hologram<org.bukkit.Location>
      Returns:
      the name

    • init

      public void init()
      Description copied from interface: Hologram
      Initialize the hologram. Call this before using the hologram.
      Specified by:
      init in interface Hologram<org.bukkit.Location>

    • clear

      public void clear()
      Description copied from interface: Hologram
      Clear the hologram
      Specified by:
      clear in interface Hologram<org.bukkit.Location>

    • isInitialized

      public boolean isInitialized()
      Description copied from interface: Hologram
      Check if the hologram is initialized
      Specified by:
      isInitialized in interface Hologram<org.bukkit.Location>
      Returns:
      true if it is

    • getLocation

      public org.bukkit.Location getLocation()
      Description copied from interface: Hologram
      Get the location of the hologram
      Specified by:
      getLocation in interface Hologram<org.bukkit.Location>
      Returns:
      the location

    • setLocation

      public void setLocation(org.bukkit.Location location)
      Description copied from interface: Hologram
      Set the location of the hologram
      Specified by:
      setLocation in interface Hologram<org.bukkit.Location>
      Parameters:
      location - the location

    • isVisible

      public boolean isVisible(org.bukkit.entity.Player viewer)
      Description copied from interface: Visibility
      Check if the viewer can see the hologram
      Specified by:
      isVisible in interface Visibility<org.bukkit.entity.Player>
      Parameters:
      viewer - the viewer
      Returns:
      true if the viewer can see the hologram

    • showAll

      public void showAll()
      Description copied from interface: Visibility
      Show the hologram to all viewers
      Specified by:
      showAll in interface Visibility<org.bukkit.entity.Player>

    • hideAll

      public void hideAll()
      Description copied from interface: Visibility
      Hide the hologram from all viewers
      Specified by:
      hideAll in interface Visibility<org.bukkit.entity.Player>

    • showTo

      public void showTo(org.bukkit.entity.Player viewer)
      Description copied from interface: Visibility
      Show the hologram to the viewer
      Specified by:
      showTo in interface Visibility<org.bukkit.entity.Player>
      Parameters:
      viewer - the viewer

    • hideTo

      public void hideTo(org.bukkit.entity.Player viewer)
      Description copied from interface: Visibility
      Hide the hologram from the viewer
      Specified by:
      hideTo in interface Visibility<org.bukkit.entity.Player>
      Parameters:
      viewer - the viewer

    • getBackgroundColor

      public Color getBackgroundColor()
      Description copied from interface: DisplayHologram
      Get the background color
      Specified by:
      getBackgroundColor in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the background color

    • setBackgroundColor

      public void setBackgroundColor(Color color)
      Description copied from interface: DisplayHologram
      Set the background color
      Specified by:
      setBackgroundColor in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      color - the background color

    • getScale

      public DisplayScale getScale()
      Description copied from interface: DisplayHologram
      Get the scale of the text
      Specified by:
      getScale in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the scale

    • setScale

      public void setScale(DisplayScale scale)
      Description copied from interface: DisplayHologram
      Set the scale of the text
      Specified by:
      setScale in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      scale - the scale

    • getShadowRadius

      public float getShadowRadius()
      Description copied from interface: DisplayHologram
      Get the shadow radius
      Specified by:
      getShadowRadius in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the shadow radius

    • setShadowRadius

      public void setShadowRadius(float radius)
      Description copied from interface: DisplayHologram
      Set the shadow radius
      Specified by:
      setShadowRadius in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      radius - the shadow radius

    • getShadowStrength

      public float getShadowStrength()
      Description copied from interface: DisplayHologram
      Get the shadow strength
      Specified by:
      getShadowStrength in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the shadow strength

    • setShadowStrength

      public void setShadowStrength(float strength)
      Description copied from interface: DisplayHologram
      Set the shadow strength
      Specified by:
      setShadowStrength in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      strength - the shadow strength

    • isShadowed

      public boolean isShadowed()
      Description copied from interface: DisplayHologram
      Get if the text is shadowed
      Specified by:
      isShadowed in interface DisplayHologram<org.bukkit.Location>
      Returns:
      true if it is

    • setShadowed

      public void setShadowed(boolean shadowed)
      Description copied from interface: DisplayHologram
      Set if the text is shadowed
      Specified by:
      setShadowed in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      shadowed - true if it is

    • getBillboard

      public DisplayBillboard getBillboard()
      Description copied from interface: DisplayHologram
      Get the billboard
      Specified by:
      getBillboard in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the billboard

    • setBillboard

      public void setBillboard(DisplayBillboard billboard)
      Description copied from interface: DisplayHologram
      Set the billboard
      Specified by:
      setBillboard in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      billboard - the billboard

    • getAlignment

      public DisplayTextAlignment getAlignment()
      Description copied from interface: DisplayHologram
      Get the text alignment
      Specified by:
      getAlignment in interface DisplayHologram<org.bukkit.Location>
      Returns:
      the text alignment

    • setAlignment

      public void setAlignment(DisplayTextAlignment alignment)
      Description copied from interface: DisplayHologram
      Set the text alignment
      Specified by:
      setAlignment in interface DisplayHologram<org.bukkit.Location>
      Parameters:
      alignment - the text alignment