Merge lp:~widelands-dev/widelands/bug-1814372-lua-gametype into lp:widelands

[Notabilis]

Adding lua method to get the type of the current game, i.e., single or multiplayer.

This allows scripts to differentiate between single- and multiplayer games, allowing to adapt to restrictions of multiplayer games.

The idea for this came up while debugging desyncs, since the lua sleep() command can lead to desyncs in multiplayer if not used properly (i.e., for all players at the same time).

[Klaus Halfmann (klaus-halfmann)]

Mhh, I do not see any code changes and cannot pull the branch, whats the Problem?

[Notabilis (notabilis27)]

Launchpad is (again...) unwilling to correctly parse the branch. I will push again, maybe that fixes it. Pulling works for me with:

bzr pull lp:~widelands-dev/widelands/bug-1814372-lua-gametype

The changes are a new method here:
https://bazaar.launchpad.net/~widelands-dev/widelands/bug-1814372-lua-gametype/view/head:/src/scripting/lua_root.cc#L164

Additional changes are mentioning the function here:
https://bazaar.launchpad.net/~widelands-dev/widelands/bug-1814372-lua-gametype/view/head:/src/scripting/lua_root.cc#L89
https://bazaar.launchpad.net/~widelands-dev/widelands/bug-1814372-lua-gametype/view/head:/src/scripting/lua_root.h#L62

[lp:~widelands-dev/widelands/bug-1814372-lua-gametype]

8963. By Notabilis on 2019-02-03

Aligning a line.

[Notabilis (notabilis27)]

Okay, looking better now.

[Klaus Halfmann (klaus-halfmann)]

Straighht forward, should not affect any current change
but can be user for later lua scripts.

@bunnybot merge

review: Approve (review, compile)

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4421. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/490530673.
Appveyor build 4209. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_bug_1814372_lua_gametype-4209.

[bunnybot (widelandsofficial)]

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

Travis build 4421. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/490530673.

[Toni Förster (stonerl)]

Just a Travis hiccup.

@bunnybot merge force

=== modified file 'src/scripting/lua_root.cc'
--- src/scripting/lua_root.cc	2018-12-13 07:24:01 +0000
+++ src/scripting/lua_root.cc	2019-02-03 07:42:46 +0000
@@ -87,7 +87,7 @@
 };
 const PropertyType<LuaGame> LuaGame::Properties[] = {
    PROP_RO(LuaGame, real_speed),   PROP_RO(LuaGame, time),      PROP_RW(LuaGame, desired_speed),
-   PROP_RW(LuaGame, allow_saving), {nullptr, nullptr, nullptr},
+   PROP_RW(LuaGame, allow_saving), PROP_RO(LuaGame, type),      {nullptr, nullptr, nullptr},
 };
 
 LuaGame::LuaGame(lua_State* /* L */) {
@@ -163,6 +163,34 @@
 	return 1;
 }
 
+/* RST
+   .. attribute:: type
+
+      (RO) One string out of 'undefined', 'singleplayer', 'netclient', 'nethost', 'replay',
+      describing the type of game that is played.
+*/
+int LuaGame::get_type(lua_State* L) {
+	// enum class GameType : uint8_t { kUndefined = 0, kSingleplayer, kNetClient, kNetHost, kReplay };
+	switch (get_game(L).game_controller()->get_game_type()) {
+		case GameController::GameType::kSingleplayer:
+			lua_pushstring(L, "singleplayer");
+			break;
+		case GameController::GameType::kNetClient:
+			lua_pushstring(L, "netclient");
+			break;
+		case GameController::GameType::kNetHost:
+			lua_pushstring(L, "nethost");
+			break;
+		case GameController::GameType::kReplay:
+			lua_pushstring(L, "replay");
+			break;
+		default:
+			lua_pushstring(L, "undefined");
+			break;
+	}
+	return 1;
+}
+
 /*
  ==========================================================
  LUA METHODS

=== modified file 'src/scripting/lua_root.h'
--- src/scripting/lua_root.h	2018-09-08 08:19:51 +0000
+++ src/scripting/lua_root.h	2019-02-03 07:42:46 +0000
@@ -59,6 +59,7 @@
 	int set_desired_speed(lua_State*);
 	int get_allow_saving(lua_State*);
 	int set_allow_saving(lua_State*);
+	int get_type(lua_State*);
 
 	/*
 	 * Lua methods