Rework ServerTPS

Author: Avanatiker

common/src/main/kotlin/com/lambda/module/hud/TPS.kt

@@ -19,19 +19,20 @@ package com.lambda.module.hud
 
 import com.lambda.module.HudModule
 import com.lambda.module.tag.ModuleTag
-import com.lambda.util.TpsClock.normalizedTickRate
+import com.lambda.util.NamedEnum
+import com.lambda.util.ServerTPS.averageMSPerTick
 import com.lambda.util.math.MathUtils.format
 
 object TPS : HudModule(
     name = "TPS",
     description = "Display the server's tick rate",
     defaultTags = setOf(ModuleTag.CLIENT, ModuleTag.NETWORK),
 ) {
-    private val format by setting("Tick format", TickFormat.Tick)
+    private val format by setting("Tick format", TickFormat.TPS)
 
-    private val text: String get() = "${format.string}: ${format.output().format(2)}"
+    private val text: String get() = "${format.displayName}: ${format.output().format(2)}${format.unit}"
 
-    // TODO: Replace by LambdaAtlas height cache
+    // TODO: Replace by LambdaAtlas height cache and actually build a proper text with highlighted parameters
 
     override val height: Double get() = 20.0
     override val width: Double get() = 50.0
@@ -42,10 +43,15 @@ object TPS : HudModule(
         }
     }
 
-    private enum class TickFormat(val output: () -> Double, val string: String) {
-        Tick({ normalizedTickRate * 20 }, "TPS"),
-        Milliseconds({ normalizedTickRate * 50 }, "MSPS"),
-        Normalized({ normalizedTickRate }, "TPSN"),
-        Percentage({ normalizedTickRate * 100 }, "TPS%")
+    @Suppress("unused")
+    private enum class TickFormat(
+        val output: () -> Double,
+        override val displayName: String,
+        val unit: String = ""
+    ) : NamedEnum {
+        TPS({ 1000 / averageMSPerTick }, "TPS"),
+        MSPT({ averageMSPerTick }, "MSPT", " ms"),
+        Normalized({ 50 / averageMSPerTick }, "TPS"),
+        Percentage({ 5000 / averageMSPerTick }, "TPS", "%")
     }
 }

common/src/main/kotlin/com/lambda/module/modules/movement/Jesus.kt

@@ -25,7 +25,7 @@ import com.lambda.event.events.WorldEvent
 import com.lambda.event.listener.SafeListener.Companion.listen
 import com.lambda.module.Module
 import com.lambda.module.tag.ModuleTag
-import com.lambda.util.Nameable
+import com.lambda.util.NamedEnum
 import com.lambda.util.math.MathUtils.toInt
 import com.lambda.util.math.VecUtils.minus
 import com.lambda.util.player.MovementUtils.isInputting
@@ -53,7 +53,7 @@ object Jesus : Module(
     private var goUp = true
     private var swimmingTicks = 0
 
-    enum class Mode(override val displayName: String, val collision: Boolean) : Nameable.NamedEnum {
+    enum class Mode(override val displayName: String, val collision: Boolean) : NamedEnum {
         NCP("NCP", true),
         NCP_DOLPHIN("NCP Dolphin", false),
         NCP_NEW("NCP New", true)

common/src/main/kotlin/com/lambda/module/modules/movement/Speed.kt

@@ -28,7 +28,7 @@ import com.lambda.interaction.rotation.RotationContext
 import com.lambda.interaction.rotation.RotationMode
 import com.lambda.module.Module
 import com.lambda.module.tag.ModuleTag
-import com.lambda.util.Nameable
+import com.lambda.util.NamedEnum
 import com.lambda.util.extension.contains
 import com.lambda.util.player.MovementUtils.addSpeed
 import com.lambda.util.player.MovementUtils.calcMoveYaw
@@ -85,7 +85,7 @@ object Speed : Module(
     private var ncpSpeed = NCP_BASE_SPEED
     private var lastDistance = 0.0
 
-    enum class Mode(override val displayName: String) : Nameable.NamedEnum {
+    enum class Mode(override val displayName: String) : NamedEnum {
         GRIM_STRAFE("Grim Strafe"),
         NCP_STRAFE("NCP Strafe"),
     }

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

@@ -22,8 +22,8 @@ package com.lambda.util
  */
 interface Nameable {
     val name: String
+}
 
-    interface NamedEnum {
-        val displayName: String
-    }
+interface NamedEnum {
+    val displayName: String
 }

…/main/kotlin/com/lambda/util/TpsClock.kt …main/kotlin/com/lambda/util/ServerTPS.ktcommon/src/main/kotlin/com/lambda/util/TpsClock.kt renamed to common/src/main/kotlin/com/lambda/util/ServerTPS.kt common/src/main/kotlin/com/lambda/util/TpsClock.kt renamed to common/src/main/kotlin/com/lambda/util/ServerTPS.kt

@@ -23,39 +23,28 @@ import com.lambda.event.listener.SafeListener.Companion.listen
 import com.lambda.util.collections.LimitedDecayQueue
 import net.minecraft.network.packet.s2c.play.WorldTimeUpdateS2CPacket
 
-object TpsClock {
-    private val tickHistory = LimitedDecayQueue<Double>(120, 5000)
+object ServerTPS {
+    // Server sends exactly one world time update every 20 server ticks (one per second).
+    private val updateHistory = LimitedDecayQueue<Long>(61, 60000)
     private var lastUpdate = 0L
 
-    /**
-     * Returns the average tick rate normalized between 0 and 1
-     */
-    val normalizedTickRate: Double
-        get() {
-            val average = tickHistory.average()
-            return if (average.isNaN()) 1.0 else average
-        }
-
-    /**
-     * Returns the average tick rate normalized multiplied by 20
-     */
-    val tickRate: Double get() = normalizedTickRate * 20
+    val averageMSPerTick: Double
+        get() = (if (updateHistory.isEmpty()) 1000.0 else updateHistory.average()) / 20
 
     init {
         listen<PacketEvent.Receive.Pre>(priority = 10000) {
             if (it.packet !is WorldTimeUpdateS2CPacket) return@listen
-
+            val currentTime = System.currentTimeMillis()
 
             if (lastUpdate != 0L) {
-                val timeElapsed = (System.nanoTime() - lastUpdate) / 1E9
-                tickHistory.add((1 / timeElapsed).coerceIn(0.0, 1.0))
+                updateHistory.add(currentTime - lastUpdate)
             }
 
-            lastUpdate = System.nanoTime()
+            lastUpdate = currentTime
         }
 
         listen<ConnectionEvent.Connect.Post> {
-            tickHistory.clear()
+            updateHistory.clear()
             lastUpdate = 0
         }
     }

common/src/main/kotlin/com/lambda/util/extension/Enum.kt

@@ -17,12 +17,11 @@
 
 package com.lambda.util.extension
 
-import com.lambda.util.Nameable
+import com.lambda.util.NamedEnum
+import com.lambda.util.StringUtils.capitalize
 
 val Enum<*>.displayValue
     get() =
-        (this as? Nameable.NamedEnum)?.displayName ?: name.split('_').joinToString(" ") { low ->
-            low.lowercase().replaceFirstChar {
-                if (it.isLowerCase()) it.titlecase() else it.toString()
-            }
-        }
+        (this as? NamedEnum)?.displayName ?: name.split('_').joinToString(" ") { low ->
+            low.capitalize()
+        }