Merge pull request #73 from Shynixn/development

Merge changes to master --release

Author: Shynixn

build.gradle

@@ -43,7 +43,7 @@ tasks.register("printVersion") {
 
 subprojects {
     group 'com.github.shynixn.mccoroutine'
-    version '2.3.0'
+    version '2.4.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.3.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.3.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.4.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.4.0")
     }
     ```
 
 === "BungeeCord"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-api:2.3.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-core:2.3.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-api:2.4.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-bungeecord-core:2.4.0")
     }
     ```
 
 === "Sponge"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-api:2.3.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-core:2.3.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-api:2.4.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-sponge-core:2.4.0")
     }
     ```
 
 === "Velocity"
 
     ```groovy
     dependencies {
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-api:2.3.0")
-        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-core:2.3.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-api:2.4.0")
+        implementation("com.github.shynixn.mccoroutine:mccoroutine-velocity-core:2.4.0")
     }
     ```
 
@@ -60,8 +60,8 @@ dependencies {
     **plugin.yml**
     ```yaml
     libraries:
-      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.3.0
-      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.3.0
+      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-api:2.4.0
+      - com.github.shynixn.mccoroutine:mccoroutine-bukkit-core:2.4.0
     ```
 
 === "Other Server"

docs/wiki/docs/tasks.md

@@ -14,8 +14,7 @@ given time.
     There is a big difference with ``delay()`` and ``Thread.sleep()``. Consult the official Kotlin Coroutines
     documentation for details, however essentially ``Thread.sleep()`` blocks the thread for a given time and
     ``delay()`` suspends the thread for a given time. When a thread is suspended, it can do other work (e.g. server handles
-    other operations like players joining or commands) compared to when a thread is blocked, it cannot do other work (e.g. server appears frozen).
-
+    other operations like players joining or commands) compared to when a thread is blocked, it cannot do other work (e.g.  server appears frozen).
 
 ````kotlin
 suspend fun sayHello() {
@@ -29,23 +28,34 @@ If you are not in a ``suspend`` function, use ``plugin.launch`` together with ``
 
 ````kotlin
 fun sayHello() {
-   plugin.launch {
+    plugin.launch {
         println("Please say hello in 2 seconds")
         delay(2000) // Delay for 2000 milliseconds
         println("hello")
-   }
+    }
 }
 ````
 
+## Delay Ticks
+
+MCCoroutine offers an extension method to use delay together with Bukkit and Sponge ticks.
+
+```kotlin
+delay(1.ticks)
+```
+
+Prefer using ``delay(1.ticks)`` when delaying on the minecraft main thread instead of ``delay(50)``. The tick extension function is more accurate than using
+milliseconds directly. The technical details are explained in this [github issue](https://github.com/Shynixn/MCCoroutine/issues/72).
+
 ## Repeating tasks
 
 If you are already in a ``suspend`` function, you can simply use traditional loops with ``delay`` to repeat tasks.
 
 ````kotlin
 suspend fun sayHello() {
     println("Please say hello 10 times every 2 seconds")
-    
-    for (i in 0 until 10){
+
+    for (i in 0 until 10) {
         delay(2000) // Delay for 2000 milliseconds
         println("hello")
     }

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

@@ -195,6 +195,20 @@ fun PluginCommand.setSuspendingTabCompleter(context: CoroutineContext, suspendin
     )
 }
 
+/**
+ * Converts the number to ticks for being used together with delay(..).
+ * E.g. delay(1.ticks).
+ * Minecraft ticks 20 times per second, which means a tick appears every 50 milliseconds. However,
+ * delay() does not directly work with the BukkitScheduler and needs millisecond manipulation to
+ * work as expected. Therefore, 1 tick does not equal 50 milliseconds when using this method standalone and only
+ * sums up to 50 milliseconds if you use it together with delay.
+ */
+val Int.ticks: Long
+    get() {
+        return (this * 50L - 25)
+    }
+
+
 interface MCCoroutine {
     /**
      * Get coroutine session for the given plugin.

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

@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList
 import org.bukkit.plugin.Plugin
 
 /**
- * A BungeeCord event which is called when an exception is raised in one of the coroutines managed by MCCoroutine.
+ * A Bukkit event which is called when an exception is raised in one of the coroutines managed by MCCoroutine.
  * Cancelling this exception causes the error to not get logged and offers to possibility for custom logging.
  */
 class MCCoroutineExceptionEvent(

mccoroutine-bukkit-sample/src/main/resources/plugin.yml

@@ -1,5 +1,5 @@
 name: MCCoroutine-Sample
-version: 2.3.0
+version: 2.4.0
 author: Shynixn
 main: com.github.shynixn.mccoroutine.bukkit.sample.MCCoroutineSamplePlugin
 commands:

mccoroutine-bungeecord-sample/src/main/resources/plugin.yml

@@ -1,5 +1,5 @@
 name: MCCoroutine-Sample
-version: 2.3.0
+version: 2.4.0
 author: Shynixn
 main: com.github.shynixn.mccoroutine.bungeecord.sample.MCCoroutineSamplePlugin
 commands:

mccoroutine-sponge-api/src/main/java/com/github/shynixn/mccoroutine/sponge/MCCoroutine.kt

@@ -154,6 +154,19 @@ fun CommandSpec.Builder.suspendingExecutor(
     return this
 }
 
+/**
+ * Converts the number to ticks for being used together with delay(..).
+ * E.g. delay(1.ticks).
+ * Minecraft ticks 20 times per second, which means a tick appears every 50 milliseconds. However,
+ * delay() does not directly work with the SpongeScheduler and needs millisecond manipulation to
+ * work as expected. Therefore, 1 tick does not equal 50 milliseconds when using this method standalone and only
+ * sums up to 50 milliseconds if you use it together with delay.
+ */
+val Int.ticks: Long
+    get() {
+        return (this * 50L - 25)
+    }
+
 interface MCCoroutine {
     /**
      * Get coroutine session for the given plugin.

mccoroutine-sponge-sample/src/main/resources/mcmod.info

@@ -1,7 +1,7 @@
 [{
     "modid": "mccoroutinesample",
     "name": "MCCoroutineSample",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "description": "MCCoroutineSample is sample plugin to use MCCoroutine in Sponge.",
     "authorList": [
         "Shynixn"