Merge lp:~widelands-dev/widelands/territorial_unify_notifications into lp:widelands

[Toni Förster]

- Notifications for Territorial are unified.
- Notifications are properly formatted (hour and minute)
- remaining time notifications and winning/losing status
  notifications are not mixed up any more
- new string added to territorial_lord
- string removed from territorial_time

Further details are here: https://wl.widelands.org/forum/post/26905/

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4422. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/490530981.
Appveyor build 4210. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4210.

[GunChleoc (gunchleoc)]

I think this is a great change. 2 nits.

Let's postpone this to Build21 though to make sure we don't get accidental nil values again.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4525. State: errored. Details: https://travis-ci.org/widelands/widelands/builds/498321069.
Appveyor build 4312. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4312.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4529. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/498743350.
Appveyor build 4316. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4316.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4595. State: errored. Details: https://travis-ci.org/widelands/widelands/builds/505417581.
Appveyor build 4383. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4383.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4687. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/516995509.
Appveyor build 4473. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4473.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4698. State: errored. Details: https://travis-ci.org/widelands/widelands/builds/517401116.
Appveyor build 4484. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4484.

[GunChleoc (gunchleoc)]

When the 20 minutes timer reaches 0, the game is not lost or won.

Note that I have pushed to this branch, so don't forget to pull, because that is so annoying when it happens.

review: Needs Fixing

[Toni Förster (stonerl)]

I'll have a look.

[Toni Förster (stonerl)]

fixed in r8979

[GunChleoc (gunchleoc)]

@bunnybot merge

review: Approve

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4788. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/524155429.
Appveyor build 4569. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_territorial_unify_notifications-4569.

=== modified file 'data/scripting/win_conditions/territorial_functions.lua'
--- data/scripting/win_conditions/territorial_functions.lua	2019-04-07 15:01:04 +0000
+++ data/scripting/win_conditions/territorial_functions.lua	2019-04-24 19:01:15 +0000
@@ -48,7 +48,7 @@
    -- We record the last winning player name here to prevent crashes with retrieving
    -- the player name when the player was just defeated a few ms ago
    last_winning_player_name = "",
-   remaining_time = 10,
+   remaining_time = 1201,
    all_player_points = {},
    points = {}
 }
@@ -112,10 +112,15 @@
    -- Set the remaining time according to whether the winner is still the same
    if territory_was_kept then
       -- Still the same winner
-      territory_points.remaining_time = territory_points.remaining_time - 30
+      territory_points.remaining_time = territory_points.remaining_time - 1
    elseif winning_points == -1 then
       -- No winner. This value is used to calculate whether to send a report to players.
-      territory_points.remaining_time = 10
+      if territory_points.remaining_time == 1800 then
+         territory_points.remaining_time = 1201
+      elseif territory_points.remaining_time ~= 1201 then
+         territory_points.remaining_time = 1800
+      end
+      
    else
       -- Winner changed
       territory_points.remaining_time = 20 * 60 -- 20 minutes
 
=== modified file 'data/scripting/win_conditions/territorial_lord.lua'
--- data/scripting/win_conditions/territorial_lord.lua	2019-03-09 10:55:24 +0000
+++ data/scripting/win_conditions/territorial_lord.lua	2019-04-24 19:01:15 +0000
@@ -42,25 +42,29 @@
       -- time in secs, if == 0 -> victory
       territory_points.remaining_time = time_to_keep_territory
 
-      local function _send_state()
+      local function _send_state(show_popup)
          set_textdomain("win_conditions")
 
          for idx, player in ipairs(plrs) do
             local msg = ""
-            if territory_points.last_winning_team == player.team or territory_points.last_winning_player == player.number then
-               msg = msg .. winning_status_header() .. vspace(8)
+            if (territory_points.last_winning_team >= 0 or territory_points.last_winning_player >= 0) then
+               if territory_points.last_winning_team == player.team or territory_points.last_winning_player == player.number then
+                  msg = msg .. winning_status_header()
+               else
+                  msg = msg .. losing_status_header(plrs)
+               end
             else
-               msg = msg .. losing_status_header(plrs) .. vspace(8)
+               msg = p(_"Currently no faction owns more than half of the map’s area.")
             end
             msg = msg .. vspace(8) .. game_status.body .. territory_status(fields, "has")
-            player:send_message(game_status.title, msg, {popup = true})
+            send_message(player, game_status.title, msg, {popup = show_popup})
          end
       end
 
       -- here is the main loop!!!
-      while true do
-         -- Sleep 30 seconds == STATISTICS_SAMPLE_TIME
-         sleep(30000)
+      while count_factions(plrs) > 1 and territory_points.remaining_time > 0 do
+         -- Sleep 1 second
+         sleep(1000)
 
          -- A player might have been defeated since the last calculation
          check_player_defeated(plrs, lost_game.title, lost_game.body)
@@ -68,16 +72,15 @@
          -- Check if a player or team is a candidate and update variables
          calculate_territory_points(fields, wl.Game().players)
 
-         -- Do this stuff, if the game is over
-         if territory_points.remaining_time == 0 or count_factions(plrs) <= 1 then
-            territory_game_over(fields, wl.Game().players, wc_descname, wc_version)
-            break
-         end
-
          -- If there is a candidate, check whether we have to send an update
-         if (territory_points.last_winning_team >= 0 or territory_points.last_winning_player >= 0) and territory_points.remaining_time >= 0 and territory_points.remaining_time % 300 == 0 then
-            _send_state()
+         if (territory_points.remaining_time % 300 == 0 and territory_points.remaining_time ~= 0) then
+            local show_popup = false
+            if territory_points.remaining_time % 600 == 0 then show_popup = true end
+            _send_state(show_popup)
          end
       end
+
+      -- Game has ended
+      territory_game_over(fields, wl.Game().players, wc_descname, wc_version)
    end
 }
 
=== modified file 'data/scripting/win_conditions/territorial_time.lua'
--- data/scripting/win_conditions/territorial_time.lua	2019-03-09 10:55:24 +0000
+++ data/scripting/win_conditions/territorial_time.lua	2019-04-24 19:01:15 +0000
@@ -36,65 +36,72 @@
       fields = wl.Game().map:count_conquerable_fields()
    end,
    func = function()
+      local game = wl.Game()
       local plrs = wl.Game().players
 
       -- set the objective with the game type for all players
       broadcast_objective("win_condition", wc_descname, wc_desc)
 
       -- variables to track the maximum 4 hours of gametime
-      local remaining_max_time = 4 * 60 * 60 -- 4 hours
+      local max_time = 4 * 60
 
-      local function _send_state()
+      local function _send_state(remaining_time, plrs, show_popup)
          set_textdomain("win_conditions")
 
-         local remaining_max_minutes = remaining_max_time // 60
+         local remaining_time_minutes = remaining_time // 60
          for idx, player in ipairs(plrs) do
             local msg = ""
-            if territory_points.remaining_time < remaining_max_time and
+            if territory_points.remaining_time < remaining_time and
                (territory_points.last_winning_team >= 0 or territory_points.last_winning_player >= 0) then
                if territory_points.last_winning_team == player.team or territory_points.last_winning_player == player.number then
-                  msg = msg .. winning_status_header() .. vspace(8)
+                  msg = msg .. winning_status_header()
                else
-                  msg = msg .. losing_status_header(plrs) .. vspace(8)
+                  msg = msg .. losing_status_header(plrs)
                end
-               -- TRANSLATORS: Refers to "You own more than half of the map’s area. Keep it for x more minute(s) to win the game."
-               msg = msg .. p((ngettext("Otherwise the game will end in %i minute.",
-                            "Otherwise the game will end in %i minutes.",
-                            remaining_max_minutes))
-                  :format(remaining_max_minutes))
+            elseif remaining_time <= 1200 then
+               territory_points.remaining_time = remaining_time
+               msg = msg .. format_remaining_time(remaining_time_minutes)
             else
-               msg = msg .. p((ngettext("The game will end in %i minute.",
-                            "The game will end in %i minutes.",
-                            remaining_max_minutes))
-                  :format(remaining_max_minutes))
+               msg = msg .. format_remaining_time(remaining_time_minutes)
             end
             msg = msg .. vspace(8) .. game_status.body .. territory_status(fields, "has")
-            player:send_message(game_status.title, msg, {popup = true})
+            send_message(player, game_status.title, msg, {popup = show_popup})
          end
       end
 
+      -- Start a new coroutine that triggers status notifications.
+      run(function()
+         local remaining_time = max_time
+         local msg = ""
+         while game.time <= ((max_time - 5) * 60 * 1000) and count_factions(plrs) > 1 and territory_points.remaining_time > 0 do
+            remaining_time, show_popup = notification_remaining_time(max_time, remaining_time)
+            if territory_points.remaining_time == 1201 then
+               msg = msg .. format_remaining_time(remaining_time) .. vspace(8) .. game_status.body .. territory_status(fields, "has")
+               broadcast(plrs, game_status.title, msg, {popup = show_popup})
+            end
+         end
+      end)
+         
       -- here is the main loop!!!
-      while true do
-         -- Sleep 30 seconds == STATISTICS_SAMPLE_TIME
-         sleep(30000)
+      while game.time < (max_time * 60 * 1000) and count_factions(plrs) > 1 and territory_points.remaining_time > 0 do
+         -- Sleep 1 second
+         sleep(1000)
 
-         remaining_max_time = remaining_max_time - 30
          -- A player might have been defeated since the last calculation
          check_player_defeated(plrs, lost_game.title, lost_game.body)
+
          -- Check if a player or team is a candidate and update variables
          -- Returns the names and points for the teams and players without a team
-         calculate_territory_points(fields, wl.Game().players)
-
-         -- Game is over, do stuff after loop
-         if territory_points.remaining_time <= 0 or remaining_max_time <= 0 or count_factions(plrs) <= 1 then break end
-
-         -- at the beginning send remaining max time message only each 30 minutes
-         -- if only 30 minutes or less are left, send each 5 minutes
-         -- also check if there is a candidate and we need to send an update
-         if ((remaining_max_time < (30 * 60) and remaining_max_time % (5 * 60) == 0)
-               or remaining_max_time % (30 * 60) == 0)
-               or territory_points.remaining_time % 300 == 0 then
-            _send_state()
+         calculate_territory_points(fields, plrs)
+
+         -- check if there is a candidate and we need to send an update 
+         if (territory_points.remaining_time % 300 == 0 and territory_points.remaining_time ~= 0) then
+            local remaining_time = (max_time * 60 * 1000 - game.time) // 1000
+            local show_popup = false
+            
+            if territory_points.remaining_time % 600 == 0 then show_popup = true end
+            _send_state(remaining_time, plrs, show_popup)
+
          end
       end
 
 
=== modified file 'data/scripting/win_conditions/win_condition_functions.lua'
--- data/scripting/win_conditions/win_condition_functions.lua	2019-03-09 08:58:52 +0000
+++ data/scripting/win_conditions/win_condition_functions.lua	2019-04-24 19:01:15 +0000
@@ -295,13 +295,13 @@
       time = (ngettext("%1% hour and %2%", "%1% hours and %2%", h, m)):bformat(h, time)
    elseif m > 0 then
       -- TRANSLATORS: Context: 'The game will end in 30 minutes.'
-      time = (ngettext("%i minute", "%i minutes", m)):format(m)
+      time = (ngettext("%i minute", "%i minutes", m)):bformat(m)
    else
       -- TRANSLATORS: Context: 'The game will end in 2 hours.'
       time = (ngettext("%1% hour", "%1% hours", h)):bformat(h)
    end
    -- TRANSLATORS: Context: 'The game will end in (2 hours and) 30 minutes.'
-   return p(_"The game will end in %s."):format(time)
+   return p(_"The game will end in %s."):bformat(time)
 end
 
 -- RST
@@ -312,7 +312,7 @@
 --    Returns the remaining time and whether the notification should popup.
 --
 --    To be used when sending status messages.
---    Status messages are to be send every 30 minutes and every 5 during the last 30 minutes,
+--    Status messages are to be sent every 30 minutes and every 5 during the last 30 minutes,
 --    the message window pops up ever hour, 30, 20 & 10 minutes before the game ends.
 --
 --    :arg max_time:    The time maximum game time in minutes