Merge lp:~widelands-dev/widelands/bug-1817550-Statistics-hook-Winconditions into lp:widelands

[hessenfarmer]

- Added statistics hook for territorial Win conditions
- Added statistics hook for artifacts wincondition
- fixed a bug in artifacts which led to coroutine error if Player defeated when reaching win condition

This is for Build 21.

Win condition statictic Windows will be shown showing the percentage of territory owned for territorial and artifacts owned for artifact wc.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4649. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/511361384.
Appveyor build 4436. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_bug_1817550_Statistics_hook_Winconditions-4436.

[GunChleoc (gunchleoc)]

2 nits - not tested yet.

[hessenfarmer (stephan-lutz)]

Thanks for the review.
the double // is intentional to get an integer back (Stats expect integers)
Will check if it is possible to move to territorial functions.

[GunChleoc (gunchleoc)]

OK, the double // is correct then :)

[hessenfarmer (stephan-lutz)]

moved the statistics Table definititon to territorial fuctions

[GunChleoc (gunchleoc)]

Tested and working :)

@bunnybot merge

review: Approve

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4794. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/524332830.
Appveyor build 4575. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_bug_1817550_Statistics_hook_Winconditions-4575.

[bunnybot (widelandsofficial)]

Refusing to merge, since Travis is not green. Use @bunnybot merge force for merging anyways.

Travis build 4794. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/524332830.

[hessenfarmer (stephan-lutz)]

Unrelated Travis failure already fixed in trunk

@bunnybot merge force

=== added file 'data/images/wui/stats/genstats_artifacts.png'
Binary files data/images/wui/stats/genstats_artifacts.png	1970-01-01 00:00:00 +0000 and data/images/wui/stats/genstats_artifacts.png	2019-04-25 06:14:06 +0000 differ
=== added file 'data/images/wui/stats/genstats_territorial_big.png'
Binary files data/images/wui/stats/genstats_territorial_big.png	1970-01-01 00:00:00 +0000 and data/images/wui/stats/genstats_territorial_big.png	2019-04-25 06:14:06 +0000 differ
=== added file 'data/images/wui/stats/genstats_territorial_small.png'
Binary files data/images/wui/stats/genstats_territorial_small.png	1970-01-01 00:00:00 +0000 and data/images/wui/stats/genstats_territorial_small.png	2019-04-25 06:14:06 +0000 differ
=== modified file 'data/scripting/win_conditions/artifacts.lua'
--- data/scripting/win_conditions/artifacts.lua	2019-02-23 09:12:18 +0000
+++ data/scripting/win_conditions/artifacts.lua	2019-04-25 06:14:06 +0000
@@ -15,6 +15,7 @@
 local wc_descname = _("Artifacts")
 local wc_version = 1
 local wc_desc = _ "Search for ancient artifacts. Once all of them are found, the team who owns most of them will win the game."
+local wc_artifacts = _"Artifacts owned"
 
 -- Table of all artifacts to conquer
 local artifact_fields = {}
@@ -50,7 +51,22 @@
          end
       end
 
+      local artifacts_owner = {}
       local plrs = wl.Game().players
+
+      -- statistic variables and functions
+      -- initializing artifacts owned table
+      local artifacts_per_player = {}
+      -- funtion to calculate actual number of owned artifacts per player
+      local function _calcowned()
+         for idx, plr in ipairs(wl.Game().players) do
+            artifacts_per_player[plr.number] = 0
+         end
+         for idx, plr in pairs(artifacts_owner) do
+         artifacts_per_player[plr.number] = artifacts_per_player[plr.number] + 1
+         end
+      end
+
       if #artifact_fields == 0 then
          for idx, plr in ipairs(plrs) do
             send_message(plr, _"No Artifacts", p(_"There are no artifacts on this map. This should not happen. Please file a bug report on %s and specify your Widelands version and the map you tried to load."):bformat("https://wl.widelands.org/wiki/ReportingBugs/"), {popup = true})
@@ -85,11 +101,22 @@
             end
          end
       end
+      
+
+      -- Install statistics hook
+      hooks.custom_statistic = {
+         name = wc_artifacts,
+         pic = "images/wui/stats/genstats_artifacts.png",
+         calculator = function(p)
+            _calcowned(p)
+            return artifacts_per_player[p.number] or 0
+         end,
+      }
 
       -- Iterate all players, if one is defeated, remove him
       -- from the list, send him a defeated message and give him full vision
       -- Check if all artifacts have been found (i.e. controlled by a player)
-      local artifacts_owner = {}
+
       repeat
          sleep(1000)
          check_player_defeated(plrs, lost_game.title, lost_game.body, wc_descname, wc_version)
@@ -115,7 +142,7 @@
 
       -- All artifacts are found, the game is over.
       local artifacts_per_team = {}
-      for idx, plr in ipairs(plrs) do
+      for idx, plr in ipairs(wl.Game().players) do
          artifacts_per_team[_getkey(plr)] = 0
       end
 
@@ -164,7 +191,6 @@
          msg = msg .. p((_"Team %1$i (%2$s) owns %3$s."):bformat(t[1].team, members, artifacts))
       end
 
-
       for idx, plr in ipairs(plrs) do
          local key = _getkey(plr)
          -- If two or more teams have the same amount of artifacts, they are all considered winners.
@@ -177,4 +203,5 @@
          end
       end
    end,
+
 }

=== modified file 'data/scripting/win_conditions/territorial_functions.lua'
--- data/scripting/win_conditions/territorial_functions.lua	2019-04-25 04:23:11 +0000
+++ data/scripting/win_conditions/territorial_functions.lua	2019-04-25 06:14:06 +0000
@@ -53,6 +53,19 @@
    points = {}
 }
 
+-- variables for the territorial winconditions statsistics hook
+fields = 0
+statistics = {
+      -- TRANSLATORS: subtext of the territorial statistics hook. Keep it short and consistent with the translation of the Win condition.
+      name = _"Territory percentage",
+      pic = "images/wui/stats/genstats_territorial_small.png",
+      calculator = function(p)
+         local pts = count_owned_valuable_fields_for_all_players(wl.Game().players)
+         return (pts[p.number]*100//fields)
+      end,
+   }
+
+
 -- RST
 -- .. function:: calculate_territory_points(fields, players, wc_descname, wc_version)
 --

=== modified file 'data/scripting/win_conditions/territorial_lord.lua'
--- data/scripting/win_conditions/territorial_lord.lua	2019-04-24 18:59:59 +0000
+++ data/scripting/win_conditions/territorial_lord.lua	2019-04-25 06:14:06 +0000
@@ -23,8 +23,6 @@
    "that area for at least 20 minutes."
 )
 
-local fields = 0
-
 return {
    name = wc_name,
    description = wc_desc,
@@ -61,6 +59,9 @@
          end
       end
 
+      -- Install statistics hook
+      hooks.custom_statistic = statistics
+
       -- here is the main loop!!!
       while count_factions(plrs) > 1 and territory_points.remaining_time > 0 do
          -- Sleep 1 second

=== modified file 'data/scripting/win_conditions/territorial_time.lua'
--- data/scripting/win_conditions/territorial_time.lua	2019-04-25 04:23:11 +0000
+++ data/scripting/win_conditions/territorial_time.lua	2019-04-25 06:14:06 +0000
@@ -27,8 +27,6 @@
    "after 4 hours, whichever comes first."
 )
 
-local fields = 0
-
 return {
    name = wc_name,
    description = wc_desc,
@@ -82,6 +80,9 @@
          end
       end)
 
+      -- Install statistics hook
+      hooks.custom_statistic = statistics
+
       -- here is the main loop!!!
       while game.time < (max_time * 60 * 1000) and count_factions(plrs) > 1 and territory_points.remaining_time > 0 do
          -- Sleep 1 second