Merge pull request #29 from OneLiteFeatherNET/develop

Release 0.4.0

Author: TheMeinerLP

.github/workflows/build-pr.yml

@@ -14,6 +14,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Setup Java
         uses: actions/setup-java@v4
         with:

.github/workflows/main-build.yml

@@ -19,8 +19,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Validate Gradle Wrapper
-        uses: gradle/actions/wrapper-validation@v4
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Setup Java
         uses: actions/setup-java@v4
         with:

.github/workflows/publish.yml

@@ -19,7 +19,8 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: '21'
-
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Build with Gradle
         run: ./gradlew build
 

build.gradle.kts

@@ -6,7 +6,13 @@ plugins {
 }
 
 group = "net.onelitefeather"
-version = "0.3.0"
+version = "0.4.0"
+
+java {
+    toolchain.languageVersion.set(JavaLanguageVersion.of(21))
+    withJavadocJar()
+    withSourcesJar()
+}
 
 dependencies {
     implementation(platform(libs.mycelium.bom))

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 #
-# Copyright © 2015-2021 the original authors.
+# Copyright © 2015 the original authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

gradlew

@@ -21,12 +21,11 @@ dependencyResolutionManagement {
     }
     versionCatalogs {
         create("libs") {
-            version("phoca", "0.5.3")
-            version("bom", "1.2.3")
+            version("bom", "1.4.3")
 
             library("mycelium.bom", "net.onelitefeather", "mycelium-bom").versionRef("bom")
 
-            library("minestom", "net.minestom", "minestom-snapshots").withoutVersion()
+            library("minestom", "net.minestom", "minestom").withoutVersion()
             library("cyano", "net.onelitefeather", "cyano").withoutVersion()
             library("junit.api", "org.junit.jupiter", "junit-jupiter-api").withoutVersion()
             library("junit.engine", "org.junit.jupiter", "junit-jupiter-engine").withoutVersion()

settings.gradle.kts

@@ -1,16 +1,67 @@
 package net.onelitefeather.coris.door;
 
 /**
- * The enumeration contains each animation state which a door can be in.
+ * Represents the different animation states that a door can be in during its lifecycle.
+ * <p>
+ * This enum defines a finite state machine for door animations, allowing for proper
+ * state management and transition control. The states represent both static positions
+ * and dynamic transition phases of door movement.
+ * </p>
+ * <p>
+ * Typical state transitions follow this pattern:
+ * {@code IDLE → OPENING → OPENED → CLOSING → IDLE}
+ * </p>
+ * <p>
+ * The enum can be used for:
+ * <ul>
+ *   <li>Controlling door animation timing and sequencing</li>
+ *   <li>Preventing invalid state transitions (e.g., opening an already opening door)</li>
+ *   <li>Synchronizing visual effects with door movement</li>
+ *   <li>Managing sound effects and particle systems</li>
+ * </ul>
  *
  * @author theEvilReaper
  * @version 1.0.0
  * @since 0.1.0
  */
 public enum AnimationState {
 
+    /**
+     * The door is in a resting state and not currently animating.
+     * <p>
+     * This is the default state for doors that are fully closed and stationary.
+     * From this state, a door can transition to {@link #OPENING} when activation occurs.
+     * </p>
+     */
     IDLE,
+
+    /**
+     * The door is currently in the process of opening.
+     * <p>
+     * This transitional state represents the animation phase where the door moves
+     * from closed to open position. During this state, the door should not accept
+     * new open commands but may accept close commands depending on implementation.
+     * </p>
+     */
     OPENING,
+
+    /**
+     * The door is fully open and stationary.
+     * <p>
+     * This state indicates that the opening animation has completed and the door
+     * is now in its fully opened position. From this state, the door can transition
+     * to {@link #CLOSING} when deactivation occurs or after a timeout period.
+     * </p>
+     */
     OPENED,
-    CLOSING,
-}
+
+    /**
+     * The door is currently in the process of closing.
+     * <p>
+     * This transitional state represents the animation phase where the door moves
+     * from open to closed position. During this state, the door should not accept
+     * new close commands but may accept open commands depending on implementation.
+     * </p>
+     */
+    CLOSING
+}

src/main/java/net/onelitefeather/coris/door/AnimationState.java

@@ -32,10 +32,11 @@ public abstract non-sealed class BaseDoor implements Door {
     /**
      * Creates a new instance from the door class with the given values.
      *
-     * @param uuid  the uuid for the door
-     * @param key   the {@link Key} for the door
-     * @param face  the face of the door
-     * @param shape the shape from the door
+     * @param uuid         the uuid for the door
+     * @param key          the {@link Key} for the door
+     * @param face         the face of the door
+     * @param shape        the shape from the door
+     * @param componentMap a map of components associated with the door
      */
     protected BaseDoor(
             @NotNull UUID uuid,