Merge pull request #15 from SLNE-Development/feat/14-add-owner-ship-to-npcs-with-spawn-reason

Feat/14 add owner ship to npcs with spawn reason

Author: TheBjoRedCraft

gradle.properties

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

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

@@ -1,6 +1,7 @@
 package dev.slne.surf.npc.api
 
 import dev.slne.surf.npc.api.npc.Npc
+import dev.slne.surf.npc.api.npc.NpcCreatorType
 import dev.slne.surf.npc.api.npc.animation.NpcAnimationType
 import dev.slne.surf.npc.api.npc.location.NpcLocation
 import dev.slne.surf.npc.api.npc.property.NpcProperty
@@ -17,6 +18,7 @@ import it.unimi.dsi.fastutil.objects.ObjectList
 import it.unimi.dsi.fastutil.objects.ObjectSet
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.text.format.NamedTextColor
+import org.bukkit.plugin.java.JavaPlugin
 import java.util.*
 
 /**
@@ -49,7 +51,9 @@ interface SurfNpcApi {
         fixedRotation: NpcRotation? = null,
         persistent: Boolean = false,
         glowing: Boolean = false,
-        glowingColor: NamedTextColor = NamedTextColor.WHITE
+        glowingColor: NamedTextColor = NamedTextColor.WHITE,
+        plugin: JavaPlugin,
+        npcCreatorType: NpcCreatorType = NpcCreatorType.Plugin(plugin.name)
     ): NpcCreationResult
 
     /**

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

@@ -9,6 +9,7 @@ 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 net.kyori.adventure.text.format.NamedTextColor
+import org.bukkit.plugin.java.JavaPlugin
 
 /**
  * Builder class for creating NPCs using a DSL.
@@ -145,10 +146,11 @@ suspend fun skin(name: String): NpcSkin {
 /**
  * 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(block: NpcDslBuilder.() -> Unit): NpcCreationResult {
+fun npc(plugin: JavaPlugin, block: NpcDslBuilder.() -> Unit): NpcCreationResult {
     val builder = NpcDslBuilder().apply(block)
     return surfNpcApi.createNpc(
         displayName = SurfComponentBuilder.builder().apply(builder.displayName).build(),
@@ -160,6 +162,7 @@ fun npc(block: NpcDslBuilder.() -> Unit): NpcCreationResult {
         fixedRotation = builder.fixedRotation,
         persistent = builder.persistent,
         glowing = builder.glowing,
-        glowingColor = builder.glowingColor
+        glowingColor = builder.glowingColor,
+        plugin = plugin
     )
 }

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

@@ -117,6 +117,14 @@ interface Npc {
     fun isStatic() =
         properties.any { it.key == NpcProperty.Internal.PERSISTENCE && it.value.value as? Boolean ?: false }
 
+    /**
+     * Checks if the NPC is created by a plugin.
+     *
+     * @return True if the NPC is created by a plugin, false otherwise.
+     */
+    fun isFromPlugin() =
+        properties.any { it.key == NpcProperty.Internal.CREATOR_TYPE && it.value.value is NpcCreatorType.Plugin }
+
 
     /**
      * Adds properties to the NPC.

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

@@ -0,0 +1,52 @@
+package dev.slne.surf.npc.api.npc
+
+/**
+ * Represents the type of an NPC creator.
+ */
+sealed class NpcCreatorType() {
+
+    /**
+     * Represents a player as the creator of the NPC.
+     *
+     * @property name The name of the player who created the NPC.
+     */
+    data class Player(val name: String) : NpcCreatorType()
+
+    /**
+     * Represents a plugin as the creator of the NPC.
+     *
+     * @property name The name of the plugin that created the NPC.
+     */
+    data class Plugin(val name: String) : NpcCreatorType()
+
+    /**
+     * Checks if the creator type is a player.
+     *
+     * @return `true` if the creator is a player, otherwise `false`.
+     */
+    fun isPlayer(): Boolean {
+        return this is Player
+    }
+
+    /**
+     * Checks if the creator type is a plugin.
+     *
+     * @return `true` if the creator is a plugin, otherwise `false`.
+     */
+    fun isPlugin(): Boolean {
+        return this is Plugin
+    }
+
+    /**
+     * Returns the name of the creator.
+     *
+     * @return The name of the creator, whether it's a player or a plugin.
+     */
+
+    fun name(): String {
+        return when (this) {
+            is Player -> name
+            is Plugin -> name
+        }
+    }
+}

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

@@ -57,5 +57,10 @@ interface NpcProperty {
          * The color of the glowing effect for the NPC.
          */
         const val GLOWING_COLOR = "glowing_color"
+
+        /**
+         * The type of the creator of the NPC.
+         */
+        const val CREATOR_TYPE = "creator_type"
     }
 }

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

@@ -88,5 +88,10 @@ interface NpcPropertyType {
          * Represents a skin data property type for an NPC.
          */
         const val SKIN_DATA = "skin_data"
+
+        /**
+         * The type of NPC creator.
+         */
+        const val NPC_CREATOR_TYPE = "npc_creator_type"
     }
 }

surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/BukkitMain.kt

@@ -33,6 +33,7 @@ class BukkitMain : SuspendingJavaPlugin() {
         propertyTypeRegistry.register(NamedTextColorPropertyType(NpcPropertyType.Types.NAMED_TEXT_COLOR))
         propertyTypeRegistry.register(NpcRotationPropertyType(NpcPropertyType.Types.NPC_ROTATION))
         propertyTypeRegistry.register(SkinDataPropertyType(NpcPropertyType.Types.SKIN_DATA))
+        propertyTypeRegistry.register(NpcCreatorTypePropertyType(NpcPropertyType.Types.NPC_CREATOR_TYPE))
 
         storageService.initialize()
         storageService.loadNpcs()

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

@@ -3,6 +3,7 @@ package dev.slne.surf.npc.bukkit.api
 import com.google.auto.service.AutoService
 import dev.slne.surf.npc.api.SurfNpcApi
 import dev.slne.surf.npc.api.npc.Npc
+import dev.slne.surf.npc.api.npc.NpcCreatorType
 import dev.slne.surf.npc.api.npc.animation.NpcAnimationType
 import dev.slne.surf.npc.api.npc.location.NpcLocation
 import dev.slne.surf.npc.api.npc.property.NpcProperty
@@ -25,6 +26,7 @@ import it.unimi.dsi.fastutil.objects.ObjectSet
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.text.format.NamedTextColor
 import net.kyori.adventure.util.Services
+import org.bukkit.plugin.java.JavaPlugin
 import java.util.*
 
 @AutoService(SurfNpcApi::class)
@@ -39,7 +41,9 @@ class BukkitSurfNpcApi : SurfNpcApi, Services.Fallback {
         fixedRotation: NpcRotation?,
         persistent: Boolean,
         glowing: Boolean,
-        glowingColor: NamedTextColor
+        glowingColor: NamedTextColor,
+        plugin: JavaPlugin,
+        npcCreatorType: NpcCreatorType
     ): NpcCreationResult {
         return npcController.createNpc(
             uniqueName,
@@ -51,7 +55,8 @@ class BukkitSurfNpcApi : SurfNpcApi, Services.Fallback {
             global,
             persistent,
             glowing,
-            glowingColor
+            glowingColor,
+            NpcCreatorType.Plugin(plugin.name)
         )
     }
 

surf-npc-bukkit/src/main/kotlin/dev/slne/surf/npc/bukkit/command/sub/NpcCreateCommand.kt

@@ -6,6 +6,7 @@ import dev.jorel.commandapi.kotlindsl.getValue
 import dev.jorel.commandapi.kotlindsl.playerExecutor
 import dev.jorel.commandapi.kotlindsl.stringArgument
 import dev.jorel.commandapi.kotlindsl.textArgument
+import dev.slne.surf.npc.api.npc.NpcCreatorType
 import dev.slne.surf.npc.api.npc.rotation.NpcRotationType
 import dev.slne.surf.npc.api.result.NpcCreationResult
 import dev.slne.surf.npc.bukkit.command.argument.rotationTypeArgument
@@ -31,6 +32,7 @@ class NpcCreateCommand(commandName: String) : CommandAPICommand(commandName) {
             val skin: String by args
             val rotationType: NpcRotationType by args
             val location = player.location
+            val createdBy = player.name
 
             if (!this.isValidName(name)) {
                 player.sendText {
@@ -57,7 +59,8 @@ class NpcCreateCommand(commandName: String) : CommandAPICommand(commandName) {
                     rotationType,
                     BukkitNpcRotation(location.yaw, location.pitch),
                     true,
-                    persistent = true
+                    persistent = true,
+                    npcCreatorType = NpcCreatorType.Player(createdBy)
                 )
 
                 if (npcResult.isFailure()) {