From dcdb817a7c92ebe6b0da371b78f9dd0faa3b7c08 Mon Sep 17 00:00:00 2001
From: bluefireoly <bluefireolymp@gmail.com>
Date: Sun, 18 Oct 2020 16:53:10 +0200
Subject: [PATCH] Changed runTask to bukkitRun

Changed the runTask method to bukkitRun and added documentation
---
 .../net/axay/kspigot/runnables/ChainableRunnables.kt      | 8 ++++----
 .../kotlin/net/axay/kspigot/runnables/KSpigotRunnables.kt | 6 +++++-
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/src/main/kotlin/net/axay/kspigot/runnables/ChainableRunnables.kt b/src/main/kotlin/net/axay/kspigot/runnables/ChainableRunnables.kt
index 5634350c..80b06464 100644
--- a/src/main/kotlin/net/axay/kspigot/runnables/ChainableRunnables.kt
+++ b/src/main/kotlin/net/axay/kspigot/runnables/ChainableRunnables.kt
@@ -40,7 +40,7 @@ abstract class ChainedRunnablePart<T, R>(
     )
 
     protected fun start(data: T) {
-        runTask(sync) {
+        bukkitRun(sync) {
             val result = invoke(data)
             next?.start(result)
         }
@@ -52,7 +52,7 @@ abstract class ChainedRunnablePart<T, R>(
         exceptionSync: Boolean,
         exceptionHandler: ((E) -> Unit)?,
     ) {
-        runTask(sync) {
+        bukkitRun(sync) {
             val result = try {
                 invoke(data)
             } catch (e: Exception) {
@@ -61,11 +61,11 @@ abstract class ChainedRunnablePart<T, R>(
                     if (sync == exceptionSync) {
                         exceptionHandler?.invoke(e as E)
                     } else if (exceptionHandler != null) {
-                        runTask(exceptionSync) {
+                        bukkitRun(exceptionSync) {
                             exceptionHandler.invoke(e as E)
                         }
                     }
-                    return@runTask
+                    return@bukkitRun
                 } else throw e
             }
             next?.startCatching(result, exceptionClass, exceptionSync, exceptionHandler)
diff --git a/src/main/kotlin/net/axay/kspigot/runnables/KSpigotRunnables.kt b/src/main/kotlin/net/axay/kspigot/runnables/KSpigotRunnables.kt
index cedf07fe..b9f51f1e 100644
--- a/src/main/kotlin/net/axay/kspigot/runnables/KSpigotRunnables.kt
+++ b/src/main/kotlin/net/axay/kspigot/runnables/KSpigotRunnables.kt
@@ -104,7 +104,11 @@ fun task(
 
 }
 
-fun runTask(sync: Boolean, runnable: () -> Unit) {
+/**
+ * Executes the given [runnable] either
+ * sync or async (specified by the [sync] parameter).
+ */
+fun bukkitRun(sync: Boolean, runnable: () -> Unit) {
     if (sync) {
         sync(runnable)
     } else {