Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rqbik/qologramapi
Hologram API
https://github.com/rqbik/qologramapi
bukkit craftbukkit minecraft minecraft-api minecraft-plugin plugin spigot
Last synced: 7 days ago
JSON representation
Hologram API
- Host: GitHub
- URL: https://github.com/rqbik/qologramapi
- Owner: rqbik
- Created: 2020-09-19T16:12:38.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-09T17:01:56.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T03:42:03.011Z (about 1 month ago)
- Topics: bukkit, craftbukkit, minecraft, minecraft-api, minecraft-plugin, plugin, spigot
- Language: Java
- Homepage:
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QologramAPI
Modern hologram API written in Kotlin.
Usage:
```kotlin
repositories {
maven { setUrl("https://jitpack.io/") }
}
dependencies {
implementation("com.github.rqbik", "QologramAPI", "1.0.8")
}
```
```kotlin
class MyPlugin : JavaPlugin(), Listener {
override fun onEnable() {
// Initialize QologramAPI
QologramAPI.initialize(this)
}
companion object {
fun createHologram(player: Player, location: Location) {
// A simple one line hologram
val hologram = Qologram(player, location, "Hello world!")
// Show hologram
hologram.show()
// A more complex multiline hologram
val multilineHologram = MultilineQologram(player, location) {
// Let's add some lines!
// Beware that they will be positioned from bottom to top.
// We can add lines that have interact event handlers
addLine("An interactive text!") { event ->
if (event.type == InteractType.RIGHT_CLICK)
event.player.sendMessage("You clicked on me!")
// Hide this hologram after click
event.hologram.hide()
}
// ...and we can add lines that don't!
addLine("A simple text.")
// We also can listen to events on any of lines:
onInteract { event ->
event.player.sendMessage("You clicked on hologram with text: ${event.line.text}")
}
}
multilineHologram.show()
// An even more complex _multipage_ hologram!
val multipageHologram = MultipageQologram(player, location) {
// The first page is automatically the one that is visible
addPage {
addLine("Click on me to go to the next page!") {
// Increment `currentPage` to go to the next page.
currentPage++
}
}
addPage {
addLine("Click on me to go to the previous page!") {
// Decrement `currentPage` to go to the previous page.
currentPage--
}
addLine("Go to the next page") {
currentPage++
}
}
addPage {
addLine("Go back to first one") {
// Set `currentPage` to 0 to go to the first page.
currentPage = 0
}
addLine("I can't be interacted with.") {
// This will never fire!
}.apply {
// Remove collision
// This allows you to shoot projectiles through hologram,
// but prevents you from interacting with it.
hasCollision = false
}
}
onInteract { event ->
if (event.interactType == InteractType.LEFT_CLICK)
event.player.sendMessage("Hey! Don't attack holograms. They have feelings too!")
}
}
multipageHologram.show()
}
}
}
```