Implement a waiting command (#6884)

core/src/com/unciv/logic/civilization/CivilizationInfo.kt

@@ -211,6 +211,13 @@ class CivilizationInfo {
      */
     var attacksSinceTurnStart = ArrayList<HistoricalAttackMemory>()
 
+    /**
+     * Queue of all civilization units that have their actions possibly pending. Internally
+     * might include e.g. non-idle units, so must be filtered before being given to any outside code.
+     * (Should be small enough that using ArrayList is fine.)
+     */
+    @Transient
+    private var dueUnits = mutableListOf<MapUnit>()
     var hasMovedAutomatedUnits = false
 
     @Transient
@@ -264,6 +271,7 @@ class CivilizationInfo {
         toReturn.totalCultureForContests = totalCultureForContests
         toReturn.totalFaithForContests = totalFaithForContests
         toReturn.attacksSinceTurnStart = attacksSinceTurnStart.copy()
+        toReturn.dueUnits = dueUnits.toMutableList()
         toReturn.hasMovedAutomatedUnits = hasMovedAutomatedUnits
         return toReturn
     }
@@ -453,6 +461,10 @@ class CivilizationInfo {
         newList.add(mapUnit)
         units = newList
 
+        // Make sure it is initialized.
+        getDueUnits()
+        dueUnits.add(mapUnit)
+
         if (updateCivInfo) {
             // Not relevant when updating TileInfo transients, since some info of the civ itself isn't yet available,
             // and in any case it'll be updated once civ info transients are
@@ -465,24 +477,43 @@ class CivilizationInfo {
         val newList = ArrayList(units)
         newList.remove(mapUnit)
         units = newList
+        dueUnits.remove(mapUnit)
         updateStatsForNextTurn() // unit upkeep
         updateDetailedCivResources()
     }
 
     fun getIdleUnits() = getCivUnits().filter { it.isIdle() }
 
-    private fun getDueUnits() = getCivUnits().filter { it.due && it.isIdle() }
+    // Drop all units that are not really 'due' anymore. We do it here to avoid caring how and where it happened.
+    // Internal side effect: if 'dueUnits' has never been initialized (new game, load game), do it here.
+    fun getDueUnits(): List<MapUnit> {
+        if (dueUnits.none())
+            dueUnits.addAll(units)
+        return dueUnits.filter { it.due && it.isIdle() }
+    }
 
     fun shouldGoToDueUnit() = UncivGame.Current.settings.checkForDueUnits && getDueUnits().any()
 
-    fun getNextDueUnit(): MapUnit? {
-        val dueUnits = getDueUnits()
-        if (dueUnits.any()) {
-            val unit = dueUnits.first()
-            unit.due = false
-            return unit
+    // Callers should consider if cycleThroughDueUnits() is not a better choice.
+    fun getNextDueUnit() = getDueUnits().firstOrNull()
+
+    fun cycleThroughDueUnits(unitToSkip: MapUnit?): MapUnit? {
+        var realDueUnits = getDueUnits();
+        if (realDueUnits.any()) {
+            var unit = realDueUnits.first();
+            // We shift the unit to the back of the queue. However, the caller may clear its 'due' state if it wants.
+            dueUnits.remove(unit);
+            dueUnits.add(unit);
+
+            if (unit == unitToSkip && realDueUnits.size > 1) {
+                unit = realDueUnits[1];
+                dueUnits.remove(unit);
+                dueUnits.add(unit);
+            }
+
+            return unit;
         }
-        return null
+        else return null;
     }
     //endregion
 

core/src/com/unciv/models/UnitAction.kt

@@ -137,6 +137,8 @@ enum class UnitActionType(
         { ImageGetter.getImage("OtherIcons/DisbandUnit") }, KeyCharAndCode.DEL),
     GiftUnit("Gift unit",
         { ImageGetter.getImage("OtherIcons/Present") }, UncivSound.Silent),
+    Wait("Wait",
+        null, 'z', UncivSound.Silent),
     ShowAdditionalActions("Show more",
         { imageGetShowMore() }, KeyCharAndCode(Input.Keys.PAGE_DOWN)),
     HideAdditionalActions("Back",

core/src/com/unciv/ui/worldscreen/WorldScreen.kt

@@ -187,7 +187,6 @@ class WorldScreen(val gameInfo: GameInfo, val viewingCiv:CivilizationInfo) : Bas
         else
             mapHolder.setCenterPosition(tileToCenterOn, immediately = true, selectUnit = true)
 
-
         tutorialController.allTutorialsShowedCallback = { shouldUpdate = true }
 
         onBackButtonClicked { backButtonAndESCHandler() }
@@ -727,6 +726,22 @@ class WorldScreen(val gameInfo: GameInfo, val viewingCiv:CivilizationInfo) : Bas
         }
     }
 
+    fun switchToNextUnit() {
+        // Try to select something new if we already have the next pending unit selected.
+        val nextDueUnit = viewingCiv.cycleThroughDueUnits(bottomUnitTable.selectedUnit)
+        if (nextDueUnit != null) {
+            mapHolder.setCenterPosition(
+                nextDueUnit.currentTile.position,
+                immediately = false,
+                selectUnit = false
+            )
+            bottomUnitTable.selectUnit(nextDueUnit)
+            shouldUpdate = true
+            // Unless 'wait' action is chosen, the unit will not be considered due anymore.
+            nextDueUnit.due = false
+        }
+    }
+
     private fun updateNextTurnButton(isSomethingOpen: Boolean) {
         nextTurnButton.update(isSomethingOpen, isPlayersTurn, waitingForAutosave, getNextTurnAction())
         nextTurnButton.setPosition(stage.width - nextTurnButton.width - 10f, topBar.y - nextTurnButton.height - 10f)
@@ -741,18 +756,7 @@ class WorldScreen(val gameInfo: GameInfo, val viewingCiv:CivilizationInfo) : Bas
                 NextTurnAction("Waiting for other players...",Color.GRAY) {}
 
             viewingCiv.shouldGoToDueUnit() ->
-                NextTurnAction("Next unit", Color.LIGHT_GRAY) {
-                    val nextDueUnit = viewingCiv.getNextDueUnit()
-                    if (nextDueUnit != null) {
-                        mapHolder.setCenterPosition(
-                            nextDueUnit.currentTile.position,
-                            immediately = false,
-                            selectUnit = false
-                        )
-                        bottomUnitTable.selectUnit(nextDueUnit)
-                        shouldUpdate = true
-                    }
-                }
+                NextTurnAction("Next unit", Color.LIGHT_GRAY) { switchToNextUnit() }
 
             viewingCiv.cities.any { it.cityConstructions.currentConstructionFromQueue == "" } ->
                 NextTurnAction("Pick construction", Color.CORAL) {

core/src/com/unciv/ui/worldscreen/unit/UnitActions.kt

@@ -68,9 +68,10 @@ object UnitActions {
         addTriggerUniqueActions(unit, actionList)
         addAddInCapitalAction(unit, actionList, tile)
 
-
         addToggleActionsAction(unit, actionList, unitTable)
 
+        addWaitAction(unit, actionList, worldScreen);
+
         return actionList
     }
 
@@ -832,4 +833,15 @@ object UnitActions {
         )
     }
 
-}
+    private fun addWaitAction(unit: MapUnit, actionList: ArrayList<UnitAction>, worldScreen: WorldScreen) {
+        if (!unit.isIdle()) return
+        if (worldScreen.viewingCiv.getDueUnits().filter { it != unit }.none()) return
+        actionList += UnitAction(
+            type = UnitActionType.Wait,
+            action = {
+                unit.due = true
+                worldScreen.switchToNextUnit()
+            }
+        )
+    }
+}