Merge branch 'tps'

Author: flemming-n-larsen

VERSIONS.MD

@@ -1,13 +1,22 @@
 # Versions
 
-## In progress
+## In progress - 0.13.4 - GUI improvements
+
+#### Bugfixes:
+
+- Bot API for Java:
+    - Major bugfix with getTurnRemaining(), which returned the wrong value.
 
 #### Changes:
 
 - GUI:
     - **Del Key**: It is now possible to use the Del key to remove a selected bot item on the Booted Bots (to unboot),
       Joined Bots, and Selected Bot lists when selecting bots for a new battle.
     - **Unboot All**: An `← Unboot All` button has been added right below the `← Unboot` button.
+    - **TPS**:
+        - The last used TPS (Turns Per Second) is now restored when starting up the GUI again.
+        - Added a "Default TPS" button to reset the TPS to the default setting (30 TPS).
+    - **Tool tips**: Added tool tip texts on the Control panel.
 
 ## 0.13.3 - Stabilization of Bot APIs - 01-Jun-2022
 

bot-api/java/src/main/java/dev/robocode/tankroyale/botapi/internal/BotInternals.java

@@ -176,7 +176,7 @@ private void setTurnRemaining(double newTurnRemaining) {
 
     public double getTurnRemaining() {
         synchronized (turnMonitor) {
-            return __distanceRemaining;
+            return __turnRemaining;
         }
     }
 

gui-app/src/main/kotlin/dev/robocode/tankroyale/gui/client/Client.kt

@@ -11,6 +11,7 @@ import dev.robocode.tankroyale.gui.client.ClientEvents.onRoundEnded
 import dev.robocode.tankroyale.gui.client.ClientEvents.onRoundStarted
 import dev.robocode.tankroyale.gui.client.ClientEvents.onTickEvent
 import dev.robocode.tankroyale.gui.model.*
+import dev.robocode.tankroyale.gui.settings.ConfigSettings
 import dev.robocode.tankroyale.gui.settings.GamesSettings
 import dev.robocode.tankroyale.gui.settings.ServerSettings
 import dev.robocode.tankroyale.gui.ui.server.ServerEvents
@@ -41,7 +42,7 @@ object Client {
 
     private lateinit var lastStartGame: StartGame
 
-    private var tps: Int? = null
+    private var lastTps: Int? = null
 
     init {
         TpsEvents.onTpsChanged.subscribe(Client) { changeTps(it.tps) }
@@ -126,7 +127,7 @@ object Client {
         }
     }
 
-    fun doNextTurn() {
+    internal fun doNextTurn() {
         if (isRunning.get() && isPaused.get()) {
             send(NextTurn())
         }
@@ -150,10 +151,10 @@ object Client {
     }
 
     private fun changeTps(tps: Int) {
-        if (isRunning.get() && tps != this.tps) {
-            this.tps = tps
+        if (isRunning.get() && tps != lastTps) {
             send(ChangeTps(tps))
         }
+        lastTps = tps
     }
 
     private fun onMessage(msg: String) {
@@ -196,6 +197,8 @@ object Client {
         participants = gameStartedEvent.participants
 
         onGameStarted.fire(gameStartedEvent)
+
+        changeTps(ConfigSettings.tps)
     }
 
     private fun handleGameEnded(gameEndedEvent: GameEndedEvent) {

gui-app/src/main/kotlin/dev/robocode/tankroyale/gui/settings/ConfigSettings.kt

@@ -2,9 +2,10 @@ package dev.robocode.tankroyale.gui.settings
 
 object ConfigSettings : PropertiesStore("Robocode Misc Settings", "config.properties") {
 
+    const val DEFAULT_TPS = 30
+
     private const val BOT_DIRECTORIES = "bot-directories"
     private const val TPS = "tps"
-    private const val DEFAULT_TPS = 30
 
     private const val BOT_DIRS_SEPARATOR = ","
 

gui-app/src/main/kotlin/dev/robocode/tankroyale/gui/ui/control/ControlPanel.kt

@@ -2,32 +2,59 @@ package dev.robocode.tankroyale.gui.ui.control
 
 import dev.robocode.tankroyale.gui.client.ClientEvents
 import dev.robocode.tankroyale.gui.client.ClientEvents.onGameStarted
+import dev.robocode.tankroyale.gui.model.TpsChangedEvent
+import dev.robocode.tankroyale.gui.settings.ConfigSettings.DEFAULT_TPS
+import dev.robocode.tankroyale.gui.ui.Hints
 import dev.robocode.tankroyale.gui.ui.Strings
 import dev.robocode.tankroyale.gui.ui.extensions.JComponentExt.addButton
 import dev.robocode.tankroyale.gui.ui.extensions.JComponentExt.setDefaultButton
+import dev.robocode.tankroyale.gui.ui.tps.TpsEvents
 import dev.robocode.tankroyale.gui.ui.tps.TpsField
 import dev.robocode.tankroyale.gui.ui.tps.TpsSlider
+import dev.robocode.tankroyale.gui.util.Event
 import dev.robocode.tankroyale.gui.util.GuiTask.enqueue
 import dev.robocode.tankroyale.gui.util.RegisterWsProtocol
+import javax.swing.JButton
 import javax.swing.JLabel
 import javax.swing.JPanel
 
 object ControlPanel : JPanel() {
 
-    private val pauseResumeButton = addButton("pause", ControlEvents.onPauseResume)
+    private val pauseResumeButton = addButton("pause", ControlEvents.onPauseResume).apply {
+        toolTipText = Hints.get("control.pause")
+    }
+
     private val nextButton = addButton("next_turn", ControlEvents.onNextTurn).apply {
+        toolTipText = Hints.get("control.next_turn")
         isEnabled = false
     }
-    private val stopButton = addButton("stop", ControlEvents.onStop)
+    private val stopButton = addButton("stop", ControlEvents.onStop).apply {
+        toolTipText = Hints.get("control.stop")
+    }
+
+    private val onDefaultTps = Event<JButton>()
 
     init {
-        addButton("restart", ControlEvents.onRestart)
+        addButton("restart", ControlEvents.onRestart).apply {
+            toolTipText = Hints.get("control.restart")
+        }
 
         RegisterWsProtocol
 
+        val tpsLabel = JLabel("TPS:")
+
         add(TpsSlider)
-        add(JLabel("TPS:"))
+        add(tpsLabel)
         add(TpsField)
+        addButton("default_tps", onDefaultTps).apply {
+            toolTipText = Hints.get("control.default_tps")
+        }
+
+        val tpsHint = Hints.get("control.tps")
+
+        TpsSlider.toolTipText = tpsHint
+        tpsLabel.toolTipText = tpsHint
+        TpsField.toolTipText = tpsHint
 
         ClientEvents.apply {
             onGamePaused.subscribe(ControlPanel) {
@@ -58,6 +85,10 @@ object ControlPanel : JPanel() {
             }
         }
 
+        onDefaultTps.subscribe(ControlPanel) {
+            TpsEvents.onTpsChanged.fire(TpsChangedEvent(DEFAULT_TPS))
+        }
+
         enqueue {
             setDefaultButton(pauseResumeButton)
         }
@@ -69,10 +100,16 @@ object ControlPanel : JPanel() {
     }
 
     private fun setPausedText() {
-        pauseResumeButton.text = Strings.get("pause")
+        pauseResumeButton.apply {
+            text = Strings.get("pause")
+            toolTipText = Hints.get("control.pause")
+        }
     }
 
     private fun setResumedText() {
-        pauseResumeButton.text = Strings.get("resume")
+        pauseResumeButton.apply {
+            text = Strings.get("resume")
+            toolTipText = Hints.get("control.resume")
+        }
     }
 }

gui-app/src/main/resources/Hints.properties

@@ -19,6 +19,30 @@ new_battle.selected_bots=\
 new_battle.start_button=\
   Requires at least %d participants, and maximum of %s participants.
 
+# Control Panel
+control.pause=\
+  Pauses the battle.
+
+control.resume=\
+  Resumes the paused battle.
+
+control.next_turn=\
+  Go to the next turn while the battle is paused. Useful for debugging.
+
+control.stop=\
+  Stops the battle.
+
+control.restart=\
+  Restarts the battle so it starts all over.
+
+control.tps=\
+  Sets the Turns Per Second (TPS). Set to <i>max</i> for fastest possible TPS.<br>\
+  Note that the TPS cannot go faster than the <em>turn timeout</em> allows for.<br>\
+  The lower <em>turn timeout</em>, the higher TPS is possible.
+
+control.default_tps=\
+  Resets the Turns Per Second (TPS) to the default:
+
 # Debug Options
 option.enable_initial_position=\
   Server-option for allowing your bot(s) to start with an initial starting position.<br>\

gui-app/src/main/resources/Strings.properties

@@ -48,11 +48,11 @@ apply=Apply
 add=Add
 remove=Remove
 url=URL
-stop=Stop
-restart=Restart
-pause=Pause
-resume=Resume
-next_turn=Next turn
+stop=Stop \u23F9
+restart=Restart \u21BA
+pause=Pause \u23F8
+resume=Resume \u25B6
+next_turn=Next turn \u2192
 bot_root_dirs=Bot Root Directories
 server_is_running=Server is running
 server_not_found=Server was not found
@@ -68,4 +68,6 @@ bot_info.country_codes=Country Code(s)
 bot_info.platform=Platform
 bot_info.programming_lang=Programming Lang.
 # Debug Options
-option.enable_initial_position.text=Enable initial start position
+option.enable_initial_position.text=Enable initial start position
+# TPS
+default_tps=Default TPS

settings.gradle.kts

@@ -1,4 +1,4 @@
-val version = "0.13.3"
+val version = "0.13.4"
 
 // Schema Generator
 include("schema:jvm")