Merge pull request #24 from SLNE-Development/pre/development

Development (v1.5.0)

Author: ammodev

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ env:
   SLNE_SNAPSHOTS_REPO_PASSWORD: ${{ secrets.SLNE_SNAPSHOTS_REPO_PASSWORD }}
   SLNE_RELEASES_REPO_USERNAME: ${{ secrets.SLNE_RELEASES_REPO_USERNAME }}
   SLNE_RELEASES_REPO_PASSWORD: ${{ secrets.SLNE_RELEASES_REPO_PASSWORD }}
-  MODULE_REGEX: "surf-npc-api.*-all\\.jar$|surf-npc-bukkit.*\\.jar$"
+  MODULE_REGEX: "surf-npc-api.*-all\\.jar$|surf-npc-bukkit.*-all\\.jar$"
   DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
 
 jobs:

gradle.properties

@@ -1,4 +1,4 @@
 kotlin.code.style=official
 kotlin.stdlib.default.dependency=false
 org.gradle.parallel=true
-version=1.21.7-1.4.4-SNAPSHOT
+version=1.21.7-1.5.0-SNAPSHOT

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/SurfNpcApi.kt

@@ -33,7 +33,7 @@ interface SurfNpcApi {
      * @param uniqueName The unique name of the NPC.
      * @param skin The skin data of the NPC.
      * @param location The location of the NPC.
-     * @param global Whether the NPC is global (default: true).
+     * @param viewers The set of UUIDs of players who can see the NPC (default: null, meaning all players).
      * @param rotationType The rotation type of the NPC (default: FIXED).
      * @param fixedRotation The fixed rotation of the NPC, if applicable (default: null).
      * @param persistent Whether the NPC should be persistent (default: false).
@@ -46,7 +46,7 @@ interface SurfNpcApi {
         uniqueName: String,
         skin: NpcSkin,
         location: NpcLocation,
-        global: Boolean = true,
+        viewers: ObjectSet<UUID>? = null,
         rotationType: NpcRotationType = NpcRotationType.PER_PLAYER,
         fixedRotation: NpcRotation? = null,
         persistent: Boolean = false,

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/dsl/NpcDslBuilder.kt

@@ -1,5 +1,8 @@
+@file:Suppress("UNCHECKED_CAST")
+
 package dev.slne.surf.npc.api.dsl
 
+import dev.slne.surf.npc.api.event.NpcEvent
 import dev.slne.surf.npc.api.npc.location.NpcLocation
 import dev.slne.surf.npc.api.npc.property.NpcProperty
 import dev.slne.surf.npc.api.npc.rotation.NpcRotation
@@ -8,8 +11,14 @@ import dev.slne.surf.npc.api.npc.skin.NpcSkin
 import dev.slne.surf.npc.api.result.NpcCreationResult
 import dev.slne.surf.npc.api.surfNpcApi
 import dev.slne.surf.surfapi.core.api.messages.builder.SurfComponentBuilder
+import dev.slne.surf.surfapi.core.api.util.mutableObject2ObjectMapOf
+import dev.slne.surf.surfapi.core.api.util.mutableObjectListOf
+import it.unimi.dsi.fastutil.objects.ObjectList
+import it.unimi.dsi.fastutil.objects.ObjectSet
 import net.kyori.adventure.text.format.NamedTextColor
 import org.bukkit.plugin.java.JavaPlugin
+import java.util.*
+import kotlin.reflect.KClass
 
 /**
  * Builder class for creating NPCs using a DSL.
@@ -38,7 +47,7 @@ class NpcDslBuilder {
     /**
      * Whether the NPC is global. Defaults to true.
      */
-    var global: Boolean = true
+    var viewers: ObjectSet<UUID>? = null
 
     /**
      * The rotation type of the NPC. Defaults to PER_PLAYER.
@@ -65,6 +74,32 @@ class NpcDslBuilder {
      */
     var glowingColor: NamedTextColor = NamedTextColor.WHITE
 
+    internal val eventHandlers =
+        mutableObject2ObjectMapOf<KClass<out NpcEvent>, ObjectList<(NpcEvent) -> Unit>>()
+
+    /**
+     * Registers an event handler for a specific type of `NpcEvent`.
+     *
+     * @param T The type of the `NpcEvent` this handler will process.
+     * @param eventClass The class of the event type to handle.
+     * @param handler The function that defines the logic for handling the specified type of `NpcEvent`.
+     */
+    fun <T : NpcEvent> withEventHandler(eventClass: KClass<T>, handler: (T) -> Unit) {
+        eventHandlers.computeIfAbsent(eventClass) { mutableObjectListOf() }
+            .add { ev -> handler(ev as T) }
+    }
+
+    /**
+     * Registers an event handler for a specific type of `NpcEvent`.
+     *
+     * @param T The type of `NpcEvent` for which the handler is being registered.
+     * @param handler A lambda function that defines the behavior when the event of type `T` is triggered.
+     */
+    inline fun <reified T : NpcEvent> withEventHandler(noinline handler: (T) -> Unit) {
+        withEventHandler(T::class, handler)
+    }
+
+
     /**
      * Configures the skin of the NPC using a DSL block.
      *
@@ -143,26 +178,31 @@ suspend fun skin(name: String): NpcSkin {
     return surfNpcApi.getSkin(name)
 }
 
-/**
- * Creates an NPC using a DSL block.
- *
- * @param plugin The JavaPlugin instance for the NPC creation.
- * @param block The DSL block for configuring the NPC.
- * @return The result of the NPC creation.
- */
 fun npc(plugin: JavaPlugin, block: NpcDslBuilder.() -> Unit): NpcCreationResult {
     val builder = NpcDslBuilder().apply(block)
-    return surfNpcApi.createNpc(
+    val result = surfNpcApi.createNpc(
         displayName = SurfComponentBuilder.builder().apply(builder.displayName).build(),
         uniqueName = builder.uniqueName,
         skin = builder.skin,
         location = builder.location,
-        global = builder.global,
+        viewers = builder.viewers,
         rotationType = builder.rotationType,
         fixedRotation = builder.fixedRotation,
         persistent = builder.persistent,
         glowing = builder.glowing,
         glowingColor = builder.glowingColor,
         plugin = plugin
     )
-}
+
+    (result as? NpcCreationResult.Success)?.let { success ->
+        builder.eventHandlers.forEach { (eventClass, handlersList) ->
+            handlersList.forEach { handler ->
+                success.npc.addEventHandler(eventClass as KClass<NpcEvent>) { ev ->
+                    handler(ev)
+                }
+            }
+        }
+    }
+
+    return result
+}

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcCollisionEvent.kt

@@ -12,9 +12,9 @@ import org.bukkit.event.HandlerList
  * @property player The player who collided with the NPC.
  */
 class NpcCollisionEvent(
-    val npc: Npc,
-    val player: Player
-) : Event() {
+    override val player: Player,
+    override val npc: Npc
+) : Event(), NpcPlayerEvent {
 
     /**
      * Returns the handler list for this event.

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcCreateEvent.kt

@@ -10,8 +10,8 @@ import org.bukkit.event.HandlerList
  * @property npc The NPC that was created.
  */
 class NpcCreateEvent(
-    val npc: Npc
-) : Event() {
+    override val npc: Npc
+) : Event(), NpcEvent {
 
     /**
      * Returns the handler list for this event.

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcDeleteEvent.kt

@@ -10,8 +10,8 @@ import org.bukkit.event.HandlerList
  * @property npc The NPC that was deleted.
  */
 class NpcDeleteEvent(
-    val npc: Npc
-) : Event() {
+    override val npc: Npc
+) : Event(), NpcEvent {
 
     /**
      * Returns the handler list for this event.

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcEvent.kt

@@ -0,0 +1,7 @@
+package dev.slne.surf.npc.api.event
+
+import dev.slne.surf.npc.api.npc.Npc
+
+interface NpcEvent {
+    val npc: Npc
+}

…ne/surf/npc/api/event/NpcDespawnEvent.kt …/slne/surf/npc/api/event/NpcHideEvent.ktsurf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcDespawnEvent.kt renamed to surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcHideEvent.kt surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcDespawnEvent.kt renamed to surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcHideEvent.kt

@@ -11,10 +11,10 @@ import org.bukkit.event.HandlerList
  * @property npc The NPC that despawned.
  * @property player The player associated with the despawn event, if applicable.
  */
-class NpcDespawnEvent(
-    val npc: Npc,
-    val player: Player
-) : Event() {
+class NpcHideEvent(
+    override val player: Player,
+    override val npc: Npc
+) : Event(), NpcPlayerEvent {
 
     /**
      * Returns the handler list for this event.

surf-npc-api/src/main/kotlin/dev/slne/surf/npc/api/event/NpcInteractEvent.kt

@@ -12,9 +12,9 @@ import org.bukkit.event.HandlerList
  * @property player The player who interacted with the NPC.
  */
 class NpcInteractEvent(
-    val npc: Npc,
-    val player: Player
-) : Event() {
+    override val player: Player,
+    override val npc: Npc
+) : Event(), NpcPlayerEvent {
 
     /**
      * Returns the handler list for this event.