save and publish component api - visualizer is not production ready

Author: twisti-dev

.idea/compiler.xml

@@ -7,5 +7,5 @@ javaVersion=21
 mcVersion=1.21.4
 
 group=dev.slne.surf
-version=1.21.4-2.0.10-SNAPSHOT
+version=1.21.4-2.1.0-SNAPSHOT
 relocationPrefix=dev.slne.surf.surfapi.libs

.idea/inspectionProfiles/Project_Default.xml

@@ -9,6 +9,7 @@ import kotlin.contracts.contract
 interface PacketOperation {
     fun execute(player: Player)
     fun add(operation: PacketOperation): PacketOperation
+    fun isEmpty(): Boolean
 
     operator fun plus(other: PacketOperation) = add(other)
 

.idea/vcs.xml

@@ -16,60 +16,69 @@ interface SurfBukkitNmsSpawnPackets {
     fun spawnItemDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: ItemDisplaySettings
+        settings: ItemDisplaySettings,
     ): PacketOperation
 
     fun spawnItemDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: ItemDisplaySettings.() -> Unit
+        settings: ItemDisplaySettings.() -> Unit,
     ): PacketOperation =
         spawnItemDisplay(entityId, position, ItemDisplaySettings.create(settings).build())
 
 
     fun spawnTextDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: TextDisplaySettings
+        settings: TextDisplaySettings,
     ): PacketOperation
 
     fun spawnTextDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: TextDisplaySettings.() -> Unit
+        settings: TextDisplaySettings.() -> Unit,
     ): PacketOperation =
         spawnTextDisplay(entityId, position, TextDisplaySettings.create(settings).build())
 
     fun updateSign(
         entityId: Int,
         position: BlockPosition,
-        settings: SignBlockUpdateSettings
+        settings: SignBlockUpdateSettings,
     ): PacketOperation
 
     fun updateSign(
         entityId: Int,
         position: BlockPosition,
-        settings: SignBlockUpdateSettings.() -> Unit
+        settings: SignBlockUpdateSettings.() -> Unit,
     ): PacketOperation =
         updateSign(entityId, position, SignBlockUpdateSettings.create(settings))
 
     fun spawnBlockDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: BlockDisplaySettings
+        settings: BlockDisplaySettings,
     ): PacketOperation
 
     fun spawnBlockDisplay(
         entityId: Int,
         position: FinePosition,
-        settings: BlockDisplaySettings.() -> Unit
+        settings: BlockDisplaySettings.() -> Unit,
     ): PacketOperation =
         spawnBlockDisplay(
             entityId,
             position,
             BlockDisplaySettings.create(settings).build()
         )
 
+    fun teleport(
+        entityId: Int,
+        position: FinePosition,
+        yaw: Float = 0f,
+        pitch: Float = 0f,
+        deltaMovement: FinePosition? = null,
+        onGround: Boolean = false
+    ): PacketOperation
+
     companion object {
         val instance = requiredService<SurfBukkitNmsSpawnPackets>()
     }

gradle.properties

@@ -1,12 +1,15 @@
 @file:JvmName("UtilBukkit")
+
 package dev.slne.surf.surfapi.bukkit.api.util
 
 import dev.slne.surf.surfapi.core.api.util.getCallerClass
 import org.bukkit.Bukkit
+import org.bukkit.Chunk
 import org.bukkit.Location
 import org.bukkit.NamespacedKey
 import org.bukkit.entity.Player
 import org.bukkit.plugin.java.JavaPlugin
+import java.util.*
 
 fun key(name: String): NamespacedKey { // TODO: Verify if this works
     return NamespacedKey(getCallingPlugin(), name)
@@ -22,3 +25,13 @@ fun forEachPlayer(action: (player: Player) -> Unit) {
 }
 
 infix fun Location.distanceSqt(other: Location): Double = distanceSquared(other)
+
+fun Iterable<UUID>.toPlayers() = mapNotNull { Bukkit.getPlayer(it) }
+fun Player.seesLocation(location: Location): Boolean {
+    val sameWorld = world == location.world
+    val chunkSent = isChunkSent(Chunk.getChunkKey(location))
+
+    println("sameWorld: $sameWorld, chunkSent: $chunkSent")
+
+    return this.world == location.world && this.isChunkSent(Chunk.getChunkKey(location))
+}

surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/nms/bridges/packets/PacketOperation.kt

@@ -1,17 +1,30 @@
 package dev.slne.surf.surfapi.bukkit.api.visualizer
 
-import dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer.SurfPatternedVisualizer
+import dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer.ExperimentalVisualizerApi
 import dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer.SurfVisualizer
+import dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer.SurfVisualizerMultipleLocations
+import dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer.SurfVisualizerSingleLocation
 import dev.slne.surf.surfapi.core.api.util.requiredService
+import org.bukkit.Location
+import java.util.*
 
+@ExperimentalVisualizerApi
 interface SurfBukkitVisualizerApi {
-    fun createVisualizer(): SurfVisualizer
-    fun createPatternedVisualizer(): SurfPatternedVisualizer
+
+    fun createSingleLocationVisualizer(location: Location): SurfVisualizerSingleLocation
+    fun createMultiLocationVisualizer(): SurfVisualizerMultipleLocations
+
+    fun getByUid(uid: UUID): SurfVisualizer?
 
     companion object {
         @JvmStatic
         val instance = requiredService<SurfBukkitVisualizerApi>()
     }
 }
 
-val surfBukkitVisualizerApi get() = SurfBukkitVisualizerApi.instance
+@ExperimentalVisualizerApi
+inline fun <reified T: SurfVisualizer> SurfBukkitVisualizerApi.getByUid(uid: UUID) = getByUid(uid) as? T
+
+
+@ExperimentalVisualizerApi
+val surfVisualizerApi get() = SurfBukkitVisualizerApi.instance

surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/nms/bridges/packets/entity/SurfBukkitNmsSpawnPackets.kt

@@ -1,31 +1,27 @@
 package dev.slne.surf.surfapi.bukkit.api.visualizer.visualizer
 
-import dev.slne.surf.surfapi.bukkit.api.nms.bridges.packets.entity.BlockDisplaySettings
-import org.bukkit.Location
+import it.unimi.dsi.fastutil.objects.ObjectSet
 import org.bukkit.Material
 import org.bukkit.entity.Player
+import org.jetbrains.annotations.Unmodifiable
+import java.util.*
 
+@ExperimentalVisualizerApi
 interface SurfVisualizer {
-    fun addVisualLocation(
-        visualLocation: Location,
-        material: Material = DEFAULT_MATERIAL,
-        consumer: BlockDisplaySettings.() -> Unit = {}
-    ) = addVisualLocation(visualLocation, material, BlockDisplaySettings.create(consumer))
-
-    fun addVisualLocation(
-        visualLocation: Location,
-        material: Material = DEFAULT_MATERIAL,
-        consumer: BlockDisplaySettings
-    )
-
-    fun removeVisualLocation(visualLocation: Location)
+    val uid: UUID
 
     fun startVisualizing(): Boolean
+    fun stopVisualizing(): Boolean
+    fun isVisualizing(): Boolean
 
+    val viewers: @Unmodifiable ObjectSet<Player>
     fun addViewer(player: Player)
     fun removeViewer(player: Player)
+    fun clearViewers()
+    fun hasViewers(): Boolean
+    fun visibleTo(player: Player): Boolean
 
-    fun stopVisualizing(): Boolean
+    fun update(strategy: UpdateStrategy = UpdateStrategy.ALL)
 
     companion object {
         @JvmField