feat(custom-events): add disableCustomEventListeners to allow for unr…

…egistering event listeners

useful for heavier event listeners such as OpEventListener

README.md

@@ -19,7 +19,7 @@ Maven
 <dependency>
   <groupId>gg.flyte</groupId>
   <artifactId>twilight</artifactId>
-  <version>1.0.27</version>
+  <version>1.0.28</version>
 </dependency>
 ```
 
@@ -29,14 +29,14 @@ maven {
     url "https://repo.flyte.gg/releases"
 }
 
-implementation "gg.flyte:twilight:1.0.27"
+implementation "gg.flyte:twilight:1.0.28"
 ```
 
 Gradle (Kotlin DSL)
 ```kotlin
 maven("https://repo.flyte.gg/releases")
 
-implementation("gg.flyte:twilight:1.0.27")
+implementation("gg.flyte:twilight:1.0.28")
 ```
 
 Certain features of Twilight require configuration, which can be done via the Twilight class. To setup a Twilight class instance, you can use the `twilight` method as shown below:

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "gg.flyte"
-version = "1.0.27"
+version = "1.0.28"
 
 repositories {
     mavenCentral()

src/main/kotlin/gg/flyte/twilight/event/Event.kt

@@ -51,6 +51,10 @@ open class CustomTwilightListener {
     val events = mutableListOf<TwilightListener>()
     val runnables = mutableListOf<BukkitTask>()
 
+    /**
+     * Unregisters this custom Twilight listener, removing all registered events and associated runnables.
+     * Any event handlers and scheduled tasks associated with this listener are deactivated.
+     */
     fun unregister() {
         events.applyForEach { unregister() }
         runnables.applyForEach { cancel() }
@@ -117,9 +121,17 @@ open class TwilightEvent(async: Boolean = false) : Event(async), Cancellable {
 /**
  * List of custom Twilight Event Listeners
  */
-val customEvents = listOf<CustomTwilightListener>(
+val customEventListeners = mutableSetOf<CustomTwilightListener>(
     GUIListener,
     InteractEventListener,
     OpEventListener
 )
 
+/**
+ * Disables custom event listeners by unregistering them from the associated events.
+ *
+ * @param events The custom event listeners to disable.
+ */
+fun disableCustomEventListeners(vararg events: CustomTwilightListener) {
+    customEventListeners -= events.toSet().also { it.applyForEach { unregister() } }
+}

src/test/kotlin/gg/flyte/twilight/EventTest.kt

@@ -1,5 +1,7 @@
 package gg.flyte.twilight
 
+import gg.flyte.twilight.event.custom.admin.listener.OpEventListener
+import gg.flyte.twilight.event.disableCustomEventListeners
 import gg.flyte.twilight.event.event
 import org.bukkit.event.player.PlayerJoinEvent
 
@@ -10,4 +12,6 @@ fun eventTest() {
     }
 
     listener.unregister()
+
+    disableCustomEventListeners(OpEventListener)
 }