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

[GunChleoc]

Economy tutorial: the building statistics window needs some time to build its contents.

[wl-zocker (wl-zocker)]

This seems to work fine at speed 1.0, but if I increase the game speed, the window still has too little time to build up. Maybe using sleep(game_speed) helps? Also, you can remove sleep(500) three lines above. I think that was enough time to build up the old buildings statistics menu.

[GunChleoc (gunchleoc)]

Good idea - done :)

[wl-zocker (wl-zocker)]

You also could have used wl.Game().desired_speed ... Or is there a difference?

[GunChleoc (gunchleoc)]

desired_speed sets the speed instead of just reading it.

[wl-zocker (wl-zocker)]

In http://bazaar.launchpad.net/~widelands-dev/widelands/trunk/view/head:/campaigns/tutorial01_basic_control.wmf/scripting/helper_functions_demonstration.lua, desired_speed is both read from and written to.

[GunChleoc (gunchleoc)]

I see. Now I'm wondering if we would have a use for the real speed as well though, because it makes a difference in multiplayer. Of course, for this branch, it doesn't matter.

[wl-zocker (wl-zocker)]

I tested your change and when using desired_speed, it works fine with speeds up to 50.

Regarding real_speed: I do not know if we want to introduce a new function that serves little purpose. Changing the speed in multiplayer scenarios might have strange effects (I guess desired_speed only works for player 1).

[GunChleoc (gunchleoc)]

real_speed is read-only, and it's the speed that the game is actually using. Desired speed is set by each user (read/write). In single player games, they are identical, but in multiplayer games, the real_speed is some form of arithmetic mean of the desired speeds of each player.

[wl-zocker (wl-zocker)]

I understand the difference between real and desired speed. I was just wondering whether we need more code (to maintain etc.). I'll approve the changes you made because the building statistics window is now always shown correctly. If you think it is necessary to keep the new function, then do so.

review: Approve

[GunChleoc (gunchleoc)]

Merged. Thanks for the review :)

=== modified file 'campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua'
--- campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua	2015-06-10 13:01:28 +0000
+++ campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua	2015-08-02 10:36:19 +0000
@@ -20,9 +20,9 @@
    sleep(2000)
    local o = message_box_objective(plr, building_stat)
    while not mv.windows.building_statistics do sleep(100) end
-   sleep(500)
    o.done = true
 
+   sleep(wl.Game().real_speed) -- The building statistics window needs some time to build up
    o = message_box_objective(plr,explain_building_stat)
    -- We cannot create several objectives with the same name. Therefore, we create o2 here once and change its visibility
    local o2 = add_campaign_objective(reopen_building_stat_obj)

=== modified file 'src/scripting/lua_root.cc'
--- src/scripting/lua_root.cc	2015-01-31 16:03:59 +0000
+++ src/scripting/lua_root.cc	2015-08-02 10:36:19 +0000
@@ -83,6 +83,7 @@
 	{nullptr, nullptr},
 };
 const PropertyType<LuaGame> LuaGame::Properties[] = {
+	PROP_RO(LuaGame, real_speed),
 	PROP_RO(LuaGame, time),
 	PROP_RW(LuaGame, desired_speed),
 	PROP_RW(LuaGame, allow_autosaving),
@@ -107,6 +108,18 @@
  */
 
 /* RST
+	.. attribute:: real_speed
+
+		(RO) The speed that the current game is running at in ms.
+			  For example, for game speed = 2x, this returns 2000.
+*/
+int LuaGame::get_real_speed(lua_State * L) {
+	lua_pushinteger(L, get_game(L).game_controller()->real_speed());
+	return 1;
+}
+
+
+/* RST
 	.. attribute:: time
 
 	(RO) The absolute time elapsed since the game was started in milliseconds.

=== modified file 'src/scripting/lua_root.h'
--- src/scripting/lua_root.h	2015-01-31 16:03:59 +0000
+++ src/scripting/lua_root.h	2015-08-02 10:36:19 +0000
@@ -48,6 +48,7 @@
 	/*
 	 * Properties
 	 */
+	int get_real_speed(lua_State * L);
 	int get_time(lua_State *);
 	int get_desired_speed(lua_State *);
 	int set_desired_speed(lua_State *);

=== added file 'test/maps/plain.wmf/scripting/test_gamespeed.lua'
--- test/maps/plain.wmf/scripting/test_gamespeed.lua	1970-01-01 00:00:00 +0000
+++ test/maps/plain.wmf/scripting/test_gamespeed.lua	2015-08-02 10:36:19 +0000
@@ -0,0 +1,11 @@
+run(function()
+   sleep(1000)
+
+   game.desired_speed = 5000
+   assert_equal(game.real_speed, 5000)
+   assert_equal(game.desired_speed, 5000)
+   assert_equal(game.real_speed, 5000)
+
+   print("# All Tests passed.")
+   wl.ui.MapView():close()
+end)