Merge pull request #5 from SLNE-Development/feat/implement-static-and-dynamic-npcs

Feat/implement static and dynamic npcs

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.1.1-SNAPSHOT
+version=1.21.7-1.2.0-SNAPSHOT

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

@@ -30,6 +30,7 @@ interface SurfNpcApi {
      * @param global Whether the NPC is global (default: true).
      * @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).
      * @return The result of the NPC creation.
      */
     fun createNpc(
@@ -39,7 +40,8 @@ interface SurfNpcApi {
         location: NpcLocation,
         global: Boolean = true,
         rotationType: NpcRotationType = NpcRotationType.PER_PLAYER,
-        fixedRotation: NpcRotation? = null
+        fixedRotation: NpcRotation? = null,
+        persistent: Boolean = false
     ): NpcCreationResult
 
     /**

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

@@ -48,6 +48,11 @@ class NpcDslBuilder {
      */
     var fixedRotation: NpcRotation? = null
 
+    /**
+     * Whether the NPC should be persistent. Defaults to false.
+     */
+    var persistent: Boolean = false
+
     /**
      * Configures the skin of the NPC using a DSL block.
      *
@@ -141,6 +146,7 @@ fun npc(block: NpcDslBuilder.() -> Unit): NpcCreationResult {
         location = builder.location,
         global = builder.global,
         rotationType = builder.rotationType,
-        fixedRotation = builder.fixedRotation
+        fixedRotation = builder.fixedRotation,
+        persistent = builder.persistent
     )
 }

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

@@ -101,6 +101,12 @@ interface Npc {
      */
     fun addProperty(property: NpcProperty)
 
+    /**
+     * Checks if the NPC is static, meaning it has a persistence property set to true.
+     * If the NPC is static, it will be persistent across server restarts.
+     */
+    fun isStatic() = properties.any { it.key == NpcProperty.Internal.PERSISTENCE && it.value.value as? Boolean ?: false }
+
 
     /**
      * Adds properties to the NPC.

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

@@ -52,5 +52,10 @@ interface NpcProperty {
          * The fixed rotation value for the NPC.
          */
         const val ROTATION_FIXED = "rotation"
+
+        /**
+         * The persistence of the NPC.
+         */
+        const val PERSISTENCE = "persistence"
     }
 }

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

@@ -33,7 +33,8 @@ class BukkitSurfNpcApi : SurfNpcApi, Services.Fallback {
         location: NpcLocation,
         global: Boolean,
         rotationType: NpcRotationType,
-        fixedRotation: NpcRotation?
+        fixedRotation: NpcRotation?,
+        persistent: Boolean
     ): NpcCreationResult {
         return npcController.createNpc(
             uniqueName,
@@ -42,7 +43,8 @@ class BukkitSurfNpcApi : SurfNpcApi, Services.Fallback {
             location,
             rotationType,
             fixedRotation ?: BukkitNpcRotation(0f, 0f),
-            global
+            global,
+            persistent
         )
     }
 

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

@@ -56,7 +56,8 @@ class NpcCreateCommand(commandName: String) : CommandAPICommand(commandName) {
                     BukkitNpcLocation(location.x, location.y, location.z, location.world.name),
                     rotationType,
                     BukkitNpcRotation(location.yaw, location.pitch),
-                    true
+                    true,
+                    persistent = true
                 )
 
                 val npc = npcController.getNpc(uniqueName)

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

@@ -43,6 +43,10 @@ class NpcListCommand(commandName: String) : CommandAPICommand(commandName) {
                             variableValue(npc.uniqueName)
                             appendSpace()
                             info("(${npc.id})")
+                            if (npc.isStatic()) {
+                                appendSpace()
+                                spacer("(Static)")
+                            }
                             clickRunsCommand("/npc info ${npc.uniqueName}")
                         }
                     )

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

@@ -40,7 +40,8 @@ class BukkitNpcController : NpcController, Services.Fallback {
         location: NpcLocation,
         rotationType: NpcRotationType,
         rotation: NpcRotation,
-        global: Boolean
+        global: Boolean,
+        persistent: Boolean
     ): NpcCreationResult {
         val id = random.nextInt()
         val nameTagId = random.nextInt()
@@ -124,6 +125,14 @@ class BukkitNpcController : NpcController, Services.Fallback {
             )
         )
 
+        npc.addProperty(
+            BukkitNpcProperty(
+                NpcProperty.Internal.PERSISTENCE, persistent, propertyTypeRegistry.get(
+                    NpcPropertyType.Types.BOOLEAN
+                ) ?: error("BOOLEAN property type not found")
+            )
+        )
+
         this.registerNpc(npc)
 
         if (global) {

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

@@ -97,7 +97,9 @@ class BukkitStorageService : StorageService, Services.Fallback {
             .filter { it.toString().endsWith(".yml") }
             .forEach(Files::delete)
 
-        npcController.getNpcs().forEach { npc ->
+        val staticNpcs = npcController.getNpcs().filter { it.isStatic() }
+
+        staticNpcs.forEach { npc ->
             val file = npcFolder.resolve("${npc.uniqueName}.yml").toFile()
             val config = YamlConfiguration()
 
@@ -118,8 +120,8 @@ class BukkitStorageService : StorageService, Services.Fallback {
             config.save(file)
         }
 
-        logger().atInfo().log("Successfully saved ${npcController.getNpcs().size} NPCs to files!")
-        return npcController.getNpcs().size
+        logger().atInfo().log("Successfully saved ${staticNpcs.size} NPCs to files!")
+        return staticNpcs.size
     }
 
     override fun import(fileName: String): Boolean {