Package me.filoghost.holographicdisplays.api.hologram

Interface Hologram

public interface Hologram
Group of one or more vertically aligned lines which appear as floating text lines and items. To create one see HolographicDisplaysAPI.createHologram(Position).

The lines are displayed in a top to bottom order starting from the hologram position and going down.

Since:
1

  • Method Details

    • getLines

      @NotNull @NotNull HologramLines getLines()
      Returns the editable lines of this hologram.
      Returns:
      the editable lines
      Since:
      1

    • getVisibilitySettings

      @NotNull @NotNull VisibilitySettings getVisibilitySettings()
      Returns the visibility settings.
      Returns:
      the visibility settings
      Since:
      1

    • getPosition

      @NotNull @NotNull Position getPosition()
      Returns the current position.
      Returns:
      the current position
      Since:
      1

    • setPosition

      void setPosition(@NotNull @NotNull Position position)
      Moves the hologram to the given position.
      Parameters:
      position - the new position
      Since:
      1

    • setPosition

      void setPosition(@NotNull @NotNull String worldName, double x, double y, double z)
      Moves the hologram to the given position.
      Parameters:
      worldName - the name of the world where the hologram should be moved
      x - the X coordinate
      y - the Y coordinate
      z - the Z coordinate
      Since:
      1

    • setPosition

      void setPosition(@NotNull @NotNull org.bukkit.World world, double x, double y, double z)
      Moves the hologram to the given position.
      Parameters:
      world - the world where the hologram should be moved
      x - the X coordinate
      y - the Y coordinate
      z - the Z coordinate
      Since:
      1

    • setPosition

      void setPosition(@NotNull @NotNull org.bukkit.Location location)
      Moves the hologram to the given position.
      Parameters:
      location - the new position
      Since:
      1

    • getPlaceholderSetting

      @NotNull @NotNull PlaceholderSetting getPlaceholderSetting()
      Returns the placeholder setting.
      Returns:
      the placeholder setting
      Since:
      1

    • setPlaceholderSetting

      void setPlaceholderSetting(@NotNull @NotNull PlaceholderSetting placeholderSetting)
      Changes the placeholder setting.
      Parameters:
      placeholderSetting - the new placeholder setting
      Since:
      1

    • delete

      void delete()
      Deletes this hologram, clearing the lines. Editing or teleporting the hologram after deleting it throws an exception. A deleted hologram should no longer be referenced.
      Since:
      1

    • isDeleted

      boolean isDeleted()
      Returns if this hologram is deleted.
      Returns:
      true if this hologram is deleted
      Since:
      1