various kdoc

Author: emyfops

common/src/main/kotlin/com/lambda/Lambda.kt

@@ -19,7 +19,6 @@ import net.minecraft.util.math.BlockPos
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
 import java.awt.Color
-import java.lang.Thread.sleep
 import java.util.*
 
 
@@ -47,10 +46,10 @@ object Lambda {
         .registerTypeAdapter(Optional::class.java, OptionalSerializer)
         .create()
 
-    fun initialize(onRender: () -> Unit = {}) {
+    fun initialize(block: () -> Unit) {
         recordRenderCall {
             Loader.initialize()
-            onRender()
+            block()
         }
     }
 }

common/src/main/kotlin/com/lambda/http/Request.kt

@@ -35,13 +35,8 @@ data class Request(
      *
      * @param name The full name of the file to be cached.
      * @param maxAge The maximum age of the cached resource. Default is 4 days.
-     *
-     * @return A pair containing the cached file and a boolean indicating whether the file was downloaded.
      */
-    fun maybeDownload(
-        name: String,
-        maxAge: Duration = 7.days,
-    ): File {
+    fun maybeDownload(name: String, maxAge: Duration = 7.days): File {
         val file = cache.resolve(name).createIfNotExists()
 
         if (

common/src/main/kotlin/com/lambda/util/BaritoneUtils.kt

@@ -11,14 +11,26 @@ object BaritoneUtils {
     @JvmStatic
     val primary: IBaritone = baritone.primaryBaritone
 
+    /**
+     * Whether Baritone is currently pathing
+     */
     val isPathing: Boolean
         get() = primary.pathingBehavior.isPathing
 
+    /**
+     * Whether Baritone is active (pathing, calculating goal, etc.)
+     */
     val isActive: Boolean
         get() = primary.customGoalProcess.isActive || primary.pathingBehavior.isPathing || primary.pathingControlManager.mostRecentInControl()
             .orElse(null)?.isActive == true
 
+    /**
+     * Sets the current Baritone goal and starts pathing
+     */
     fun setGoalAndPath(goal: Goal) = primary.customGoalProcess.setGoalAndPath(goal)
 
+    /**
+     * Force cancel Baritone
+     */
     fun cancel() = primary.pathingBehavior.cancelEverything()
 }

common/src/main/kotlin/com/lambda/util/KeyCode.kt

@@ -141,6 +141,17 @@ enum class KeyCode(val keyCode: Int) {
         fun fromKeyCode(keyCode: Int) = keyCodeMap[keyCode] ?: UNBOUND
         fun fromKeyName(name: String) = nameMap[name.lowercase()] ?: UNBOUND
 
+        /**
+         * Maps a US virtual keyboard input to a [KeyCode].
+         *
+         * For key codes in the keypad range, the [keyCode] is directly mapped.
+         * If the key corresponds to a printable character or letter, it is mapped
+         * to its corresponding [KeyCode] based on the US layout.
+         *
+         * @param keyCode The key code to map.
+         * @param scanCode The scan code of the key.
+         * @return The corresponding [KeyCode].
+         */
         fun virtualMapUS(keyCode: Int, scanCode: Int): KeyCode {
             if (keyCode in GLFW.GLFW_KEY_KP_0..GLFW.GLFW_KEY_KP_EQUAL) return fromKeyCode(keyCode)