vital-holograms/dev.vitalframework.holograms

Package-level declarations

Types

open class VitalHologram(var id: UUID, var lines: List<Supplier<VitalHologram.Line>>, var location: Location, var armorStandUniqueId: UUID, var lineArmorStandUniqueIds: List<UUID>) : VitalEntity<UUID>

Global hologram used to display information that is always the same for every player. This hologram can't display any unique text for different players. E.g., if you need to display language-specific text, use VitalPlayerHologram.

VitalHologramException

abstract class VitalHologramException(message: String) : RuntimeException

Internal exception; thrown during VitalHologram lifecycles.

VitalHologramRepository

class VitalHologramRepository : VitalRepository<VitalHologram, UUID>

Global repository; stores all holograms created with VitalHologramService.

VitalHologramService

class VitalHologramService(plugin: SpigotPlugin, vitalHologramRepository: VitalHologramRepository)

Global service to create and delete holograms. Every created hologram will be stored globally in VitalHologramRepository.

VitalHologramsModule

class VitalHologramsModule : VitalModule

Defines the official vital-holograms module, which is displayed when Vital starts. It contains the Vital holograms system, which can be used to create global and per-player based holograms.

VitalPlayerHologram

class VitalPlayerHologram(id: UUID, lines: List<Function<SpigotPlayer, VitalHologram.Line>>, location: Location, armorStandUniqueId: UUID, lineArmorStandUniqueIds: List<UUID>, var playerUniqueId: UUID) : VitalHologram

Global hologram used to display player-specific data on a hologram for the given player. Only the specified player will be able to see the created hologram when you create it using VitalHologramService.createPlayerHologram.

VitalPlayerHologramListener

class VitalPlayerHologramListener(vitalHologramService: VitalHologramService) : VitalListener.Spigot

Internal listener; Hides all holograms from other players using VitalHologramService.hideOtherPlayerHolograms.