Hologram

data class Hologram

The default Hologram class. Contains a list of pages, as well as a name and location.

Functions

addPage
Link copied to clipboard
fun addPage(vararg lines: String): HologramPage
Add a page to the Hologram.
component1
Link copied to clipboard
operator fun component1(): String
copy
Link copied to clipboard
fun copy(name: String, locationData: Location, pageData: MutableList<HologramPage> = mutableListOf()): Hologram
despawn
Link copied to clipboard
fun despawn()
Despawn a hologram.
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getCurrentPageIndex
Link copied to clipboard
fun getCurrentPageIndex(player: Player): Int?
Get the current page a Player is looking at.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
hideAllPages
Link copied to clipboard
fun hideAllPages(player: Player)
A method to hide all the pages.
insertPage
Link copied to clipboard
fun insertPage(index: Int, vararg lines: String): HologramPage
Inserts a page for this Hologram.
removePage
Link copied to clipboard
fun removePage(index: Int): HologramPage?
Remove a page from the Hologram
setPage
Link copied to clipboard
fun setPage(index: Int, vararg lines: String): Boolean
Sets a page of this Hologram
showNextPage
Link copied to clipboard
fun showNextPage(vararg players: Player)
Will show the next page to a player.
showPreviousPage
Link copied to clipboard
fun showPreviousPage(vararg players: Player)
Will show the previous hologram page to a player.
teleport
Link copied to clipboard
fun teleport(location: Location)
Teleport a hologram to a new location.
toString
Link copied to clipboard
open override fun toString(): String
update
Link copied to clipboard
fun update()
Update the whole hologram.

Properties

hasPageArrows
Link copied to clipboard
@Expose()
var hasPageArrows: Boolean
Set this to false if you want to remove the page arrows.
leftArrow
Link copied to clipboard
@Expose()
var leftArrow: String
The left page arrow.
location
Link copied to clipboard
val location: Location
The location of this Hologram.
name
Link copied to clipboard
@Expose()
var name: String
pages
Link copied to clipboard
val pages: List<HologramPage>
The HologramPages of the Hologram.
rightArrow
Link copied to clipboard
@Expose()
var rightArrow: String
The right page arrow.