Debug Feature: Added TrackSoundsCommand (#855)

Co-authored-by: Linnea Gräf <nea@nea.moe>
Co-authored-by: hannibal2 <24389977+hannibal002@users.noreply.github.com>
Co-authored-by: hannibal2 <24389977+hannibal00212@users.noreply.github.com>

1 files changed, 92 insertions, 0 deletions

diff --git a/src/main/java/at/hannibal2/skyhanni/test/command/TrackSoundsCommand.kt b/src/main/java/at/hannibal2/skyhanni/test/command/TrackSoundsCommand.kt
new file mode 100644
index 000000000..7b0fcddbd
--- /dev/null
+++ b/src/main/java/at/hannibal2/skyhanni/test/command/TrackSoundsCommand.kt
@@ -0,0 +1,92 @@
+package at.hannibal2.skyhanni.test.command
+
+import at.hannibal2.skyhanni.SkyHanniMod
+import at.hannibal2.skyhanni.events.GuiRenderEvent
+import at.hannibal2.skyhanni.events.LorenzTickEvent
+import at.hannibal2.skyhanni.events.PlaySoundEvent
+import at.hannibal2.skyhanni.utils.ChatUtils
+import at.hannibal2.skyhanni.utils.OSUtils
+import at.hannibal2.skyhanni.utils.RenderUtils.renderRenderables
+import at.hannibal2.skyhanni.utils.SimpleTimeMark
+import at.hannibal2.skyhanni.utils.SimpleTimeMark.Companion.fromNow
+import at.hannibal2.skyhanni.utils.renderables.Renderable
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
+import java.util.concurrent.ConcurrentLinkedDeque
+import kotlin.time.Duration
+import kotlin.time.Duration.Companion.seconds
+
+object TrackSoundsCommand {
+
+    private var cutOfTime: SimpleTimeMark = SimpleTimeMark.farPast()
+    private var startTime: SimpleTimeMark = SimpleTimeMark.farPast()
+
+    private val sounds = ConcurrentLinkedDeque<Pair<Duration, PlaySoundEvent>>()
+
+    private var isRecording = false
+
+    private val position get() = SkyHanniMod.feature.dev.debug.trackSoundPosition
+
+    private var display: List<Renderable> = emptyList()
+
+    fun command(args: Array<String>) {
+        if (args.firstOrNull() == "end") {
+            if (!isRecording) {
+                ChatUtils.userError("Nothing to end")
+            } else {
+                cutOfTime = SimpleTimeMark.now()
+            }
+            return
+        }
+        if (isRecording) {
+            ChatUtils.userError(
+                "Still tracking sounds, wait for the other tracking to complete before starting a new one, " +
+                    "or type §e/shtracksounds end §cto end it prematurely"
+            )
+            return
+        }
+        isRecording = true
+        sounds.clear()
+        startTime = SimpleTimeMark.now()
+        cutOfTime = args.firstOrNull()?.toInt()?.seconds?.let {
+            ChatUtils.chat("Now started tracking sounds for ${it.inWholeSeconds} Seconds")
+            it.fromNow()
+        } ?: run {
+            ChatUtils.chat("Now started tracking sounds until manually ended")
+            SimpleTimeMark.farFuture()
+        }
+    }
+
+    @SubscribeEvent
+    fun onTick(event: LorenzTickEvent) {
+        if (!isRecording) return
+
+        display = sounds.takeWhile { startTime.passedSince() - it.first < 3.0.seconds }
+            .take(10).reversed().map {
+                Renderable.string("§3" + it.second.soundName + " §8p:" + it.second.pitch + " §7v:" + it.second.volume)
+            }
+
+        // The function must run after cutOfTime has passed to ensure thread safety
+        if (cutOfTime.passedSince() <= 0.1.seconds) return
+        val string = sounds.reversed().joinToString("\n") { "Time: ${it.first.inWholeMilliseconds}  ${it.second}" }
+        val counter = sounds.size
+        OSUtils.copyToClipboard(string)
+        ChatUtils.chat("$counter sounds copied into the clipboard!")
+        sounds.clear()
+        isRecording = false
+    }
+
+    @SubscribeEvent
+    fun onSoundEvent(event: PlaySoundEvent) {
+        if (cutOfTime.isInPast()) return
+        if (event.soundName == "game.player.hurt" && event.pitch == 0f && event.volume == 0f) return // remove random useless sound
+        if (event.soundName == "") return // sound with empty name aren't useful
+        event.distanceToPlayer // Need to call to initialize Lazy
+        sounds.addFirst(startTime.passedSince() to event)
+    }
+
+    @SubscribeEvent
+    fun onRender(event: GuiRenderEvent.GuiOverlayRenderEvent) {
+        if (cutOfTime.isInPast()) return
+        position.renderRenderables(display, posLabel = "Track sound log")
+    }
+}