Merge pull request #13 from SLNE-Development/feat/sealed-classes-and-equals-methods

Feat/sealed classes and equals methods

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.0-SNAPSHOT
+version=1.21.7-1.3.1-SNAPSHOT

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

@@ -114,7 +114,8 @@ interface Npc {
      * 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 }
+    fun isStatic() =
+        properties.any { it.key == NpcProperty.Internal.PERSISTENCE && it.value.value as? Boolean ?: false }
 
 
     /**

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

@@ -1,24 +1,60 @@
 package dev.slne.surf.npc.api.result
 
+import dev.slne.surf.npc.api.npc.Npc
+
 /**
- * Enum representing the result of an NPC creation attempt.
+ * Represents the result of an NPC creation attempt.
  */
-enum class NpcCreationResult {
-    /** Indicates that the NPC was successfully created. */
-    SUCCESS,
+sealed class NpcCreationResult {
+    /**
+     * Indicates that the NPC was created successfully.
+     *
+     * @property npc The created NPC instance.
+     */
+    data class Success(val npc: Npc) : NpcCreationResult()
+
+    /**
+     * Indicates that the NPC creation failed.
+     *
+     * @property reason The reason for the failure.
+     */
+    data class Failure(val reason: NpcCreationFailureReason) : NpcCreationResult()
+
+    /**
+     * Checks if the result represents a successful NPC creation.
+     *
+     * @return `true` if the result is a success, otherwise `false`.
+     */
+    fun isSuccess(): Boolean {
+        return this is Success
+    }
 
-    /** Indicates that the NPC creation failed because an NPC with the same identifier already exists. */
-    FAILED_ALREADY_EXISTS,
+    /**
+     * Checks if the result represents a failed NPC creation.
+     *
+     * @return `true` if the result is a failure, otherwise `false`.
+     */
+    fun isFailure(): Boolean {
+        return this is Failure
+    }
+}
+
+/**
+ * Enumerates possible reasons for NPC creation failure.
+ */
+enum class NpcCreationFailureReason {
+    /** An NPC with the same identifier already exists. */
+    ALREADY_EXISTS,
 
-    /** Indicates that the NPC creation failed due to an invalid location. */
-    FAILED_INVALID_LOCATION,
+    /** The specified location is invalid. */
+    INVALID_LOCATION,
 
-    /** Indicates that the NPC creation failed due to an invalid name. */
-    FAILED_INVALID_NAME,
+    /** The specified name is invalid. */
+    INVALID_NAME,
 
-    /** Indicates that the NPC creation failed due to an invalid skin. */
-    FAILED_INVALID_SKIN,
+    /** The specified skin is invalid. */
+    INVALID_SKIN,
 
-    /** Indicates that the NPC creation failed due to an unspecified reason. */
-    FAILED_OTHER
+    /** The failure reason is unknown. */
+    UNKNOWN
 }

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

@@ -10,6 +10,7 @@ enum class NpcDeletionResult {
     /** Indicates that the NPC deletion failed because the NPC was not found. */
     FAILED_NOT_FOUND,
 
+    /** Indicates that the NPC deletion failed because the NPC was not spawned. */
     FAILED_NOT_SPAWNED,
 
     /** Indicates that the NPC deletion failed due to an unspecified reason. */

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

@@ -1,21 +1,54 @@
 package dev.slne.surf.npc.api.result
 
+import dev.slne.surf.npc.api.npc.Npc
+
 /**
- * Enum representing the result of an NPC respawn attempt.
+ * Represents the result of an NPC despawn attempt.
  */
-enum class NpcDespawnResult {
-    /** Indicates that the NPC was successfully respawned. */
-    SUCCESS,
+sealed class NpcDespawnResult {
+    /**
+     * Indicates that the NPC was successfully despawned.
+     *
+     * @property npc The NPC instance that was successfully despawned.
+     */
+    data class Success(val npc: Npc) : NpcDespawnResult()
+
+    /**
+     * Indicates that the NPC despawn attempt failed.
+     *
+     * @property reason The reason for the despawn failure.
+     */
+    data class Failure(val reason: NpcDespawnFailureReason) : NpcDespawnResult()
+
+    /**
+     * Checks if the result represents a successful NPC despawn.
+     *
+     * @return `true` if the result is a success, otherwise `false`.
+     */
+    fun isSuccess(): Boolean {
+        return this is Success
+    }
+
+    /**
+     * Checks if the result represents a failed NPC despawn.
+     *
+     * @return `true` if the result is a failure, otherwise `false`.
+     */
+    fun isFailure(): Boolean {
+        return this is Failure
+    }
+}
 
-    /** Indicates that the NPC respawn failed because the NPC does not exist. */
-    FAILED_NOT_EXIST,
+enum class NpcDespawnFailureReason {
+    /** The NPC does not exist. */
+    NOT_EXIST,
 
-    /** Indicates that the NPC respawn failed because the NPC is already spawned. */
-    FAILED_ALREADY_SPAWNED,
+    /** The NPC is not spawned. */
+    NOT_SPAWNED,
 
-    /** Indicates that the NPC respawn failed due to no valid location being available. */
-    FAILED_NO_LOCATION,
+    /** The NPC is already despawned. */
+    ALREADY_DESPAWNED,
 
-    /** Indicates that the NPC respawn failed due to an unspecified reason. */
-    FAILED_OTHER
+    /** The failure reason is unknown. */
+    UNKNOWN
 }

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

@@ -1,21 +1,54 @@
 package dev.slne.surf.npc.api.result
 
+import dev.slne.surf.npc.api.npc.Npc
+
 /**
- * Enum representing the result of an NPC respawn attempt.
+ * Represents the result of an NPC respawn attempt.
  */
-enum class NpcRespawnResult {
-    /** Indicates that the NPC was successfully respawned. */
-    SUCCESS,
+sealed class NpcRespawnResult {
+    /**
+     * Indicates that the NPC was successfully respawned.
+     *
+     * @property npc The NPC instance that was successfully respawned.
+     */
+    data class Success(val npc: Npc) : NpcRespawnResult()
+
+    /**
+     * Indicates that the NPC respawn attempt failed.
+     *
+     * @property reason The reason for the respawn failure.
+     */
+    data class Failure(val reason: NpcRespawnFailureReason) : NpcRespawnResult()
+
+    /**
+     * Checks if the result represents a successful NPC respawn.
+     *
+     * @return `true` if the result is a success, otherwise `false`.
+     */
+    fun isSuccess(): Boolean {
+        return this is Success
+    }
+
+    /**
+     * Checks if the result represents a failed NPC respawn.
+     *
+     * @return `true` if the result is a failure, otherwise `false`.
+     */
+    fun isFailure(): Boolean {
+        return this is Failure
+    }
+}
 
-    /** Indicates that the NPC respawn failed because the NPC does not exist. */
-    FAILED_NOT_EXIST,
+enum class NpcRespawnFailureReason {
+    /** The NPC does not exist. */
+    NOT_EXIST,
 
-    /** Indicates that the NPC respawn failed because the NPC is already spawned. */
-    FAILED_ALREADY_SPAWNED,
+    /** The NPC is already spawned. */
+    ALREADY_SPAWNED,
 
-    /** Indicates that the NPC respawn failed due to no valid location being available. */
-    FAILED_NO_LOCATION,
+    /** No valid location is available for respawning the NPC. */
+    NO_LOCATION,
 
-    /** Indicates that the NPC respawn failed due to an unspecified reason. */
-    FAILED_OTHER
+    /** The failure reason is unknown. */
+    UNKNOWN
 }

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

@@ -1,21 +1,54 @@
 package dev.slne.surf.npc.api.result
 
+import dev.slne.surf.npc.api.npc.Npc
+
 /**
- * Enum representing the result of an NPC respawn attempt.
+ * Sealed class representing the result of an NPC spawn attempt.
  */
-enum class NpcSpawnResult {
-    /** Indicates that the NPC was successfully respawned. */
-    SUCCESS,
+sealed class NpcSpawnResult {
+    /**
+     * Represents a successful NPC spawn result.
+     *
+     * @property npc The NPC instance that was successfully spawned.
+     */
+    data class Success(val npc: Npc) : NpcSpawnResult()
+
+    /**
+     * Represents a failed NPC spawn result.
+     *
+     * @property reason The reason for the spawn failure.
+     */
+    data class Failure(val reason: NpcSpawnFailureReason) : NpcSpawnResult()
+
+    /**
+     * Checks if the result represents a successful NPC spawn.
+     *
+     * @return `true` if the result is a success, otherwise `false`.
+     */
+    fun isSuccess(): Boolean {
+        return this is Success
+    }
+
+    /**
+     * Checks if the result represents a failed NPC spawn.
+     *
+     * @return `true` if the result is a failure, otherwise `false`.
+     */
+    fun isFailure(): Boolean {
+        return this is Failure
+    }
+}
 
-    /** Indicates that the NPC respawn failed because the NPC does not exist. */
-    FAILED_NOT_EXIST,
+enum class NpcSpawnFailureReason {
+    /** The NPC does not exist. */
+    NOT_EXIST,
 
-    /** Indicates that the NPC respawn failed because the NPC is already spawned. */
-    FAILED_ALREADY_SPAWNED,
+    /** The NPC is already spawned. */
+    ALREADY_SPAWNED,
 
-    /** Indicates that the NPC respawn failed due to no valid location being available. */
-    FAILED_NO_LOCATION,
+    /** No valid location is available for spawning the NPC. */
+    NO_LOCATION,
 
-    /** Indicates that the NPC respawn failed due to an unspecified reason. */
-    FAILED_OTHER
+    /** The failure reason is unknown. */
+    UNKNOWN
 }

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

@@ -60,26 +60,17 @@ class NpcCreateCommand(commandName: String) : CommandAPICommand(commandName) {
                     persistent = true
                 )
 
-                val npc = npcController.getNpc(uniqueName)
-
-                if (npc == null) {
+                if (npcResult.isFailure()) {
                     player.sendText {
                         appendPrefix()
-                        error("Der Npc konnte nicht erstellt werden: ${npcResult.name}")
+                        error("Der Npc konnte nicht erstellt werden: ${(npcResult as? NpcCreationResult.Failure)?.reason}")
                     }
                     return@launch
                 }
 
-                if (npcResult == NpcCreationResult.SUCCESS) {
-                    player.sendText {
-                        appendPrefix()
-                        success("Der Npc wurde erfolgreich erstellt.")
-                    }
-                } else {
-                    player.sendText {
-                        appendPrefix()
-                        error("Der Npc konnte nicht erstellt werden: ${npcResult.name}")
-                    }
+                player.sendText {
+                    appendPrefix()
+                    success("Der Npc wurde erfolgreich erstellt.")
                 }
             }
         }