hotbar, interaction, inventory docs

Author: beanbag44

src/main/kotlin/com/lambda/interaction/request/ActionInfo.kt

@@ -19,6 +19,10 @@ package com.lambda.interaction.request
 
 import com.lambda.interaction.construction.context.BuildContext
 
+/**
+ * A simple interface to provide a basic object to hold key information that managers might need if information
+ * must persist longer than the request.
+ */
 interface ActionInfo {
     val context: BuildContext
     val pendingInteractionsList: MutableCollection<BuildContext>

src/main/kotlin/com/lambda/interaction/request/DebugLogger.kt

@@ -35,6 +35,9 @@ import imgui.flag.ImGuiWindowFlags
 import java.awt.Color
 import java.util.*
 
+/**
+ * A simple logger that can be used to display information about what is happening within the managers.
+ */
 class DebugLogger(
     val name: String
 ) {

src/main/kotlin/com/lambda/interaction/request/PositionBlocking.kt

@@ -19,6 +19,11 @@ package com.lambda.interaction.request
 
 import net.minecraft.util.math.BlockPos
 
+/**
+ * Provides a [blockedPositions] list to inform other managers what positions should not be processed.
+ *
+ * Reasons a position could be blocked include pending interactions and or active interactions.
+ */
 interface PositionBlocking {
     val blockedPositions: List<BlockPos>
 }

src/main/kotlin/com/lambda/interaction/request/PostActionHandler.kt

@@ -25,6 +25,9 @@ import com.lambda.event.listener.UnsafeListener.Companion.listenUnsafe
 import com.lambda.interaction.request.breaking.BrokenBlockHandler
 import com.lambda.util.collections.LimitedDecayQueue
 
+/**
+ * A simple interface for handlers of actions that need some sort of server response after being executed.
+ */
 abstract class PostActionHandler<T : ActionInfo> {
     abstract val pendingActions: LimitedDecayQueue<T>
 

src/main/kotlin/com/lambda/interaction/request/Request.kt

@@ -19,8 +19,15 @@ package com.lambda.interaction.request
 
 import com.lambda.context.Automated
 
+/**
+ * A simple format to ensure basic requirements and information when requesting a manager.
+ *
+ * @property requestId Used for tracking how many requests there have been and what number this request is.
+ * @property fresh If this request is new.
+ * @property done If this request has been completed.
+ */
 abstract class Request : Automated {
-    abstract val requestID: Int
+    abstract val requestId: Int
     var fresh = true
 
     abstract val done: Boolean

src/main/kotlin/com/lambda/interaction/request/RequestConfig.kt

@@ -55,7 +55,7 @@ abstract class RequestHandler<R : Request>(
     var queuedRequest: R? = null; protected set
 
     /**
-     * Represents if the handler performed any external actions within this tick
+     * Represents if the handler performed any actions within this tick
      */
     var activeThisTick = false; protected set
 

src/main/kotlin/com/lambda/interaction/request/RequestHandler.kt

@@ -19,13 +19,12 @@ package com.lambda.interaction.request.breaking
 
 import com.lambda.config.groups.BuildConfig
 import com.lambda.event.Event
-import com.lambda.interaction.request.RequestConfig
 import com.lambda.util.Describable
 import com.lambda.util.NamedEnum
 import net.minecraft.block.Block
 import java.awt.Color
 
-interface BreakConfig : RequestConfig {
+interface BreakConfig {
     val breakMode: BreakMode
     val sorter: SortMode
     val rebreak: Boolean

src/main/kotlin/com/lambda/interaction/request/breaking/BreakConfig.kt

@@ -104,8 +104,8 @@ import kotlin.math.max
 import kotlin.math.min
 
 /**
- * This manager is responsible for breaking blocks in the most efficient manner possible. It can be accessed
- * from anywhere through a [BreakRequest], although it is not designed in the image of thread safety.
+ * Manager responsible for breaking blocks in the most efficient manner possible. It can be accessed
+ * from anywhere through a [BreakRequest].
  *
  * If configured with the right options enabled, this manager can break two blocks simultaneously, even if the two breaks come from
  * different requests. Each break will be handled using its own config, and just like the other managers, priority is a first-come, first-served

src/main/kotlin/com/lambda/interaction/request/breaking/BreakManager.kt

@@ -36,7 +36,7 @@ import net.minecraft.util.math.BlockPos
  *
  * The callbacks can be used to keep track of the break progress.
  *
- * The class has a private constructor to force use of the cleaner [BreakRequestDsl] builder. This is
+ * A private constructor is used to force use of the cleaner [BreakRequestDsl] builder. This is
  * accessed through the [breakRequest] method.
  *
  * @param contexts A collection of [BreakContext]'s gathered from the [com.lambda.interaction.construction.simulation.BuildSimulator].
@@ -47,7 +47,7 @@ data class BreakRequest private constructor(
     val pendingInteractions: MutableCollection<BuildContext>,
     private val automated: Automated
 ) : Request(), LogContext, Automated by automated {
-    override val requestID = ++requestCount
+    override val requestId = ++requestCount
 
     var onStart: (SafeContext.(BlockPos) -> Unit)? = null
     var onUpdate: (SafeContext.(BlockPos) -> Unit)? = null
@@ -65,7 +65,7 @@ data class BreakRequest private constructor(
 
     override fun getLogContextBuilder(): LogContextBuilder.() -> Unit = {
         group("Break Request") {
-            value("Request ID", requestID)
+            value("Request ID", requestId)
             value("Contexts", contexts.size)
             group("Callbacks") {
                 value("onStart", onStart != null)