sort contextual build results by current tool, if not build context

Author: beanbag44

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

@@ -60,7 +60,8 @@ data class BreakContext(
     override fun compareTo(other: BuildContext): Int = runSafe {
         return when (other) {
             is BreakContext -> compareByDescending<BreakContext> {
-                if (breakConfig.sorter == BreakConfig.SortMode.Tool) it.hotbarIndex == HotbarManager.serverSlot
+                if (breakConfig.sorter == BreakConfig.SortMode.Tool)
+                    it.hotbarIndex == HotbarManager.serverSlot
                 else 0
             }.thenBy {
                 when (breakConfig.sorter) {

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

@@ -20,13 +20,9 @@ package com.lambda.interaction.construction.result
 import com.lambda.util.Nameable
 import net.minecraft.util.math.BlockPos
 
-abstract class BuildResult : Nameable, ComparableResult<Rank>() {
+abstract class BuildResult : Nameable, ComparableResult<Rank> {
     abstract val pos: BlockPos
     override val compareBy = this
 
-    final override fun compareTo(other: ComparableResult<Rank>) =
-        compareBy.compareResult(other.compareBy)
-
-    open fun compareResult(other: ComparableResult<Rank>) =
-        compareBy.rank.compareTo(other.compareBy.rank)
+    final override fun compareTo(other: ComparableResult<Rank>) = super.compareTo(other)
 }

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

@@ -17,7 +17,13 @@
 
 package com.lambda.interaction.construction.result
 
-abstract class ComparableResult<T : Enum<T>> : Comparable<ComparableResult<T>> {
-    abstract val rank: T
-    abstract val compareBy: ComparableResult<T>
+interface ComparableResult<T : Enum<T>> : Comparable<ComparableResult<T>> {
+    val rank: T
+    val compareBy: ComparableResult<T>
+
+    override fun compareTo(other: ComparableResult<T>) =
+        compareBy.compareResult(other.compareBy)
+
+    fun compareResult(other: ComparableResult<T>): Int =
+        compareBy.rank.compareTo(other.compareBy.rank)
 }

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

@@ -18,7 +18,20 @@
 package com.lambda.interaction.construction.result
 
 import com.lambda.interaction.construction.context.BuildContext
+import com.lambda.interaction.request.hotbar.HotbarManager
 
-interface Contextual {
+interface Contextual : ComparableResult<Rank> {
     val context: BuildContext
+
+    override fun compareResult(other: ComparableResult<Rank>) =
+        when (other) {
+
+            is Contextual -> compareByDescending<Contextual> {
+                it.context.hotbarIndex == HotbarManager.serverSlot
+            }.thenBy {
+                it.compareBy.rank
+            }.compare(this, other)
+
+            else -> compareBy.rank.compareTo(other.compareBy.rank)
+        }
 }

src/main/kotlin/com/lambda/interaction/construction/result/results/BreakResult.kt

@@ -42,15 +42,16 @@ import net.minecraft.util.math.Direction
 import java.awt.Color
 
 sealed class BreakResult : BuildResult() {
+    override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
+
     /**
      * Represents a successful break. All checks have been passed.
      * @param context The context of the break.
      */
     data class Break(
         override val pos: BlockPos,
         override val context: BreakContext,
-    ) : Drawable, Contextual, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
+    ) : Contextual, Drawable, BreakResult() {
         override val rank = Rank.BreakSuccess
 
         override fun ShapeBuilder.buildRenderer() {
@@ -60,7 +61,7 @@ sealed class BreakResult : BuildResult() {
         override fun compareResult(other: ComparableResult<Rank>) =
             when (other) {
                 is Break -> context.compareTo(other.context)
-                else -> super.compareResult(other)
+                else -> super<Contextual>.compareResult(other)
             }
     }
 
@@ -73,7 +74,6 @@ sealed class BreakResult : BuildResult() {
         override val pos: BlockPos,
         val side: Direction,
     ) : Drawable, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.BreakNotExposed
         private val color = Color(46, 0, 0, 30)
 
@@ -98,7 +98,6 @@ sealed class BreakResult : BuildResult() {
         val blockState: BlockState,
         val badItem: Item
     ) : Drawable, Resolvable, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.BreakItemCantMine
         private val color = Color(255, 0, 0, 100)
 
@@ -134,7 +133,6 @@ sealed class BreakResult : BuildResult() {
         override val pos: BlockPos,
         val blockState: BlockState
     ) : Drawable, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.BreakSubmerge
         private val color = Color(114, 27, 255, 100)
 
@@ -150,7 +148,6 @@ sealed class BreakResult : BuildResult() {
         override val pos: BlockPos,
         val blockState: BlockState,
     ) : Drawable, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.BreakIsBlockedByFluid
         private val color = Color(50, 12, 112, 100)
 
@@ -166,7 +163,6 @@ sealed class BreakResult : BuildResult() {
         override val pos: BlockPos,
         val blockState: BlockState,
     ) : Navigable, Drawable, BreakResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.BreakPlayerOnTop
         private val color = Color(252, 3, 207, 100)
 
@@ -181,7 +177,6 @@ sealed class BreakResult : BuildResult() {
         override val pos: BlockPos,
         override val dependency: BuildResult
     ) : BreakResult(), Dependent by Dependent.Nested(dependency) {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = dependency.rank
         override val compareBy = lastDependency
     }

src/main/kotlin/com/lambda/interaction/construction/result/results/InteractResult.kt

@@ -28,11 +28,12 @@ import com.lambda.interaction.construction.result.Rank
 import net.minecraft.util.math.BlockPos
 
 sealed class InteractResult : BuildResult() {
+    override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
+
     data class Interact(
         override val pos: BlockPos,
         override val context: InteractionContext
     ) : Contextual, Drawable, InteractResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.InteractSuccess
 
         override fun ShapeBuilder.buildRenderer() {
@@ -42,15 +43,14 @@ sealed class InteractResult : BuildResult() {
         override fun compareResult(other: ComparableResult<Rank>) =
             when (other) {
                 is Interact -> context.compareTo(other.context)
-                else -> super.compareResult(other)
+                else -> super<Contextual>.compareResult(other)
             }
     }
 
     data class Dependency(
         override val pos: BlockPos,
         override val dependency: BuildResult
     ) : InteractResult(), Dependent by Dependent.Nested(dependency) {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = dependency.rank
         override val compareBy = lastDependency
     }

src/main/kotlin/com/lambda/interaction/construction/result/results/PlaceResult.kt

@@ -45,6 +45,8 @@ import java.awt.Color
  * First based on the context, then based on the [com.lambda.interaction.construction.result.Rank].
  */
 sealed class PlaceResult : BuildResult() {
+    override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
+
     /**
      * Represents a successful placement. All checks have been passed.
      * @param context The context of the placement.
@@ -53,7 +55,6 @@ sealed class PlaceResult : BuildResult() {
         override val pos: BlockPos,
         override val context: PlaceContext,
     ) : Contextual, Drawable, PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceSuccess
 
         override fun ShapeBuilder.buildRenderer() {
@@ -63,7 +64,7 @@ sealed class PlaceResult : BuildResult() {
         override fun compareResult(other: ComparableResult<Rank>) =
             when (other) {
                 is Place -> context.compareTo(other.context)
-                else -> super.compareResult(other)
+                else -> super<Contextual>.compareResult(other)
             }
     }
 
@@ -84,7 +85,6 @@ sealed class PlaceResult : BuildResult() {
         val simulated: ItemPlacementContext,
         val actual: BlockState? = null,
     ) : Drawable, PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceNoIntegrity
         private val color = Color(252, 3, 3, 100)
 
@@ -101,7 +101,6 @@ sealed class PlaceResult : BuildResult() {
     data class BlockedByEntity(
         override val pos: BlockPos,
     ) : Navigable, PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceBlockedByPlayer
 
         // ToDo: check what type of entity. player -> leave box, other entity -> kill?
@@ -118,7 +117,6 @@ sealed class PlaceResult : BuildResult() {
         override val pos: BlockPos,
         val simulated: ItemPlacementContext,
     ) : Resolvable, PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceCantReplace
 
         context(automated: Automated)
@@ -135,7 +133,6 @@ sealed class PlaceResult : BuildResult() {
         override val pos: BlockPos,
         val simulated: ItemPlacementContext,
     ) : PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceScaffoldExceeded
     }
 
@@ -150,7 +147,6 @@ sealed class PlaceResult : BuildResult() {
         override val pos: BlockPos,
         val itemStack: ItemStack,
     ) : PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceBlockFeatureDisabled
     }
 
@@ -164,7 +160,6 @@ sealed class PlaceResult : BuildResult() {
         override val pos: BlockPos,
         val actualPos: BlockPos,
     ) : PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.UnexpectedPosition
     }
 
@@ -178,15 +173,13 @@ sealed class PlaceResult : BuildResult() {
     data class IllegalUsage(
         override val pos: BlockPos,
     ) : PlaceResult() {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = Rank.PlaceIllegalUsage
     }
 
     data class Dependency(
         override val pos: BlockPos,
         override val dependency: BuildResult
     ) : PlaceResult(), Dependent by Dependent.Nested(dependency) {
-        override val name: String get() = "${this::class.simpleName} at ${pos.toShortString()}"
         override val rank = lastDependency.rank
         override val compareBy = lastDependency
     }