Merge branch '1.21.5' into improvement/documentation

# Conflicts:
#	src/main/kotlin/com/lambda/interaction/request/breaking/BreakManager.kt
#	src/main/kotlin/com/lambda/interaction/request/breaking/BreakRequest.kt
#	src/main/kotlin/com/lambda/interaction/request/breaking/BrokenBlockHandler.kt
#	src/main/kotlin/com/lambda/interaction/request/breaking/SwapInfo.kt

Author: beanbag44

src/main/kotlin/com/lambda/interaction/construction/context/BuildContext.kt

@@ -25,6 +25,9 @@ import net.minecraft.block.BlockState
 import net.minecraft.util.hit.BlockHitResult
 import net.minecraft.util.math.BlockPos
 
+/**
+ * Holds the necessary information for managers to perform actions.
+ */
 abstract class BuildContext : Comparable<BuildContext>, Drawable, Automated {
     abstract val hitResult: BlockHitResult
     abstract val rotationRequest: RotationRequest

src/main/kotlin/com/lambda/interaction/construction/processing/PlacementProcessor.kt

@@ -20,6 +20,11 @@ package com.lambda.interaction.construction.processing
 import net.minecraft.block.BlockState
 import net.minecraft.util.math.BlockPos
 
+/**
+ * The class all pre-processors must extend to provide the structure. Preprocessors are used to
+ * optimize how blocks are simulated. Some blocks might only be placeable on certain sides, so it is
+ * unnecessary to scan all of them, for example.
+ */
 abstract class PlacementProcessor {
     abstract fun acceptsState(state: BlockState): Boolean
     abstract fun preProcess(state: BlockState, pos: BlockPos, accumulator: PreProcessingInfoAccumulator)

src/main/kotlin/com/lambda/interaction/construction/processing/ProcessingStep.kt

@@ -29,6 +29,10 @@ object ProcessorRegistry : Loadable {
     private val processors = getInstances<PlacementProcessor>()
     private val processorCache = Collections.synchronizedMap<BlockState, PreProcessingInfo?>(mutableMapOf())
 
+    /**
+     * List of properties that can be processed after the block is placed. This is often used to ignore these properties
+     * when placing blocks, as sometimes they can only be set to the right state after placement.
+     */
     val postProcessedProperties = setOf(
         Properties.EXTENDED,
         Properties.EYE,
@@ -106,6 +110,13 @@ object ProcessorRegistry : Loadable {
 
     override fun load() = "Loaded ${processors.size} pre processors"
 
+    /**
+     * [PreProcessingInfo]'s are cached to avoid duplicate computations as block states are immutable.
+     *
+     * @return A [PreProcessingInfo] object containing information about the block state. This method runs through
+     * each pre-processor checking if the state can be accepted. If so, the state is passed through the pre-processor
+     * which can call the functions within the [PreProcessingInfoAccumulator] DSL to modify the information.
+     */
     fun TargetState.getProcessingInfo(pos: BlockPos): PreProcessingInfo? =
         if (this !is TargetState.State) PreProcessingInfo.DEFAULT
         else {

src/main/kotlin/com/lambda/interaction/construction/processing/ProcessorRegistry.kt

@@ -20,6 +20,9 @@ package com.lambda.interaction.construction.result
 import com.lambda.interaction.construction.context.BuildContext
 import com.lambda.interaction.request.hotbar.HotbarManager
 
+/**
+ * Represents a result holding a [BuildContext].
+ */
 interface Contextual : ComparableResult<Rank> {
     val context: BuildContext
 

src/main/kotlin/com/lambda/interaction/construction/processing/TaskPlanner.kt

@@ -17,6 +17,9 @@
 
 package com.lambda.interaction.construction.result
 
+/**
+ * Represents a [BuildResult] that depends on another [BuildResult].
+ */
 interface Dependent {
     val dependency: BuildResult
     val lastDependency: BuildResult

src/main/kotlin/com/lambda/interaction/construction/result/Contextual.kt

@@ -19,6 +19,9 @@ package com.lambda.interaction.construction.result
 
 import com.lambda.graphics.renderer.esp.ShapeBuilder
 
+/**
+ * Represents a [BuildResult] that can be rendered in-game.
+ */
 interface Drawable {
     fun ShapeBuilder.buildRenderer()
 }

src/main/kotlin/com/lambda/interaction/construction/result/Dependent.kt

@@ -19,6 +19,9 @@ package com.lambda.interaction.construction.result
 
 import baritone.api.pathing.goals.Goal
 
+/**
+ * Represents a [BuildResult] with a pathing goal.
+ */
 interface Navigable {
     val goal: Goal
 }

src/main/kotlin/com/lambda/interaction/construction/result/Drawable.kt

@@ -20,6 +20,9 @@ package com.lambda.interaction.construction.result
 import com.lambda.context.Automated
 import com.lambda.task.Task
 
+/**
+ * Represents a [BuildResult] with a resolvable [Task]
+ */
 interface Resolvable {
     context(automated: Automated)
     fun resolve(): Task<*>