Merge pull request #86 from Shynixn/development

Merge changes to Master --release

Author: Shynixn

.gitignore

@@ -2,4 +2,6 @@
 *.iml
 local.properties
 *.log
-*.class
+*.class
+.gradle
+build

README.md

@@ -60,7 +60,10 @@ private suspend fun bob() {
 
 ## Getting started
 
-* [User Guide](https://shynixn.github.io/MCCoroutine/wiki/site/)
+* [Wiki and User Guide](https://shynixn.github.io/MCCoroutine/wiki/site/)
+
+## Resources
+
 * [MCCoroutine JavaDocs for the Bukkit-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.bukkit/index.html)
 * [MCCoroutine JavaDocs for the Sponge-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.sponge/index.html)
 * [MCCoroutine JavaDocs for the BungeeCord-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.bungeecord/index.html)

build.gradle

@@ -43,7 +43,7 @@ tasks.register("printVersion") {
 
 subprojects {
     group 'com.github.shynixn.mccoroutine'
-    version '2.6.0'
+    version '2.7.0'
 
     sourceCompatibility = 1.8
 

docs/wiki/docs/installation.md

@@ -8,35 +8,35 @@ In order to use the MCCoroutine Kotlin API, you need to include the following li
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.6.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.6.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.7.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.7.0")
     }
     ```
 
 === "BungeeCord"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-api:2.6.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-core:2.6.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-api:2.7.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-core:2.7.0")
     }
     ```
 
 === "Sponge"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-api:2.6.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-core:2.6.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-api:2.7.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-core:2.7.0")
     }
     ```
 
 === "Velocity"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-api:2.6.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-core:2.6.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-api:2.7.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-core:2.7.0")
     }
     ```
 
@@ -60,8 +60,8 @@ dependencies {
     **plugin.yml**
     ```yaml
     libraries:
-      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.6.0
-      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.6.0
+      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.7.0
+      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.7.0
     ```
 
 === "Other Server"

docs/wiki/docs/plugindisable.md

@@ -0,0 +1 @@
+# TODO

docs/wiki/mkdocs.yml

@@ -13,6 +13,7 @@ nav:
     - 'Suspending Delayed, Repeating Tasks': tasks.md
     - 'Suspending API Functions': bridge.md
     - 'Suspending Caches, Background Repeating Tasks': caching.md
+  #  - 'Launching coroutines in onDisable': plugindisable.md
     - 'Exception Handling': exception.md
     - 'Timing Measurements': timings.md
   - 'FAQ': faq.md

mccoroutine-bukkit-api/src/main/java/com/github/shynixn/mccoroutine/bukkit/MCCoroutineExceptionEvent.kt

@@ -1,8 +1,8 @@
 package com.github.shynixn.mccoroutine.bukkit
 
 import org.bukkit.event.Cancellable
-import org.bukkit.event.server.PluginEvent
 import org.bukkit.event.HandlerList
+import org.bukkit.event.server.ServerEvent
 import org.bukkit.plugin.Plugin
 
 /**
@@ -13,12 +13,13 @@ class MCCoroutineExceptionEvent(
     /**
      * Plugin causing the exception.
      */
-    plugin: Plugin,
+    val plugin: Plugin,
     /**
      * The exception to be logged.
      */
     val exception: Throwable
-) : PluginEvent(plugin), Cancellable {
+    // Paper requires explicit isAsync false flag.
+) : ServerEvent(false), Cancellable {
     private var cancelled: Boolean = false
 
     /**

mccoroutine-bukkit-core/src/main/java/com/github/shynixn/mccoroutine/bukkit/dispatcher/AsyncCoroutineDispatcher.kt

@@ -20,17 +20,13 @@ internal open class AsyncCoroutineDispatcher(
      */
     override fun isDispatchNeeded(context: CoroutineContext): Boolean {
         wakeUpBlockService.ensureWakeup()
-        return plugin.server.isPrimaryThread
+        return plugin.server.isPrimaryThread && plugin.isEnabled
     }
 
     /**
      * Handles dispatching the coroutine on the correct thread.
      */
     override fun dispatch(context: CoroutineContext, block: Runnable) {
-        if (!plugin.isEnabled) {
-            return
-        }
-
         plugin.server.scheduler.runTaskAsynchronously(plugin, block)
     }
 }

mccoroutine-bukkit-core/src/main/java/com/github/shynixn/mccoroutine/bukkit/dispatcher/MinecraftCoroutineDispatcher.kt

@@ -21,7 +21,7 @@ internal open class MinecraftCoroutineDispatcher(
      */
     override fun isDispatchNeeded(context: CoroutineContext): Boolean {
         wakeUpBlockService.ensureWakeup()
-        return !plugin.server.isPrimaryThread
+        return !plugin.server.isPrimaryThread && plugin.isEnabled
     }
 
     /**

mccoroutine-bukkit-core/src/main/java/com/github/shynixn/mccoroutine/bukkit/impl/MCCoroutineImpl.kt

@@ -40,7 +40,7 @@ class MCCoroutineImpl : MCCoroutine {
      */
     private fun startCoroutineSession(plugin: Plugin) {
         if (!plugin.isEnabled) {
-            throw RuntimeException("Plugin ${plugin.name} attempt to start a new coroutine session while being disabled. Dispatchers such as plugin.minecraftDispatcher and plugin.asyncDispatcher are already disposed at this point and cannot be used!")
+            throw RuntimeException("Plugin ${plugin.name} attempt to start a new coroutine session while being disabled. Dispatchers such as plugin.minecraftDispatcher and plugin.asyncDispatcher are already disposed at this point and cannot be used! If you are starting a coroutine in onDisable, consider using runBlocking instead.")
         }
 
         val pluginListener = PluginListener(this, plugin)