Server: Add reason for leave to on_leaveplayer callbacks

kaeza · paramat · commit dac40af6eeeb · 2016-06-11T04:17:04.000+01:00
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -1912,8 +1912,9 @@ Call these functions only at load time!
      * If it returns a string, the player is disconnected with that string as reason
 * `minetest.register_on_joinplayer(func(ObjectRef))`
     * Called when a player joins the game
-* `minetest.register_on_leaveplayer(func(ObjectRef))`
+* `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
     * Called when a player leaves the game
+    * `timed_out`: True for timeout, false for other reasons.
 * `minetest.register_on_cheat(func(ObjectRef, cheat))`
     * Called when a player cheats
     * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
diff --git a/src/script/cpp_api/s_player.cpp b/src/script/cpp_api/s_player.cpp
@@ -135,7 +135,8 @@ void ScriptApiPlayer::on_joinplayer(ServerActiveObject *player)
 	runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);
 }
 
-void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player)
+void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player,
+		bool timeout)
 {
 	SCRIPTAPI_PRECHECKHEADER
 
@@ -144,7 +145,8 @@ void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player)
 	lua_getfield(L, -1, "registered_on_leaveplayers");
 	// Call callbacks
 	objectrefGetOrCreate(L, player);
-	runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);
+	lua_pushboolean(L, timeout);
+	runCallbacks(2, RUN_CALLBACKS_MODE_FIRST);
 }
 
 void ScriptApiPlayer::on_cheat(ServerActiveObject *player,
diff --git a/src/script/cpp_api/s_player.h b/src/script/cpp_api/s_player.h
@@ -38,7 +38,7 @@ class ScriptApiPlayer
 	bool on_prejoinplayer(const std::string &name, const std::string &ip,
 		std::string *reason);
 	void on_joinplayer(ServerActiveObject *player);
-	void on_leaveplayer(ServerActiveObject *player);
+	void on_leaveplayer(ServerActiveObject *player, bool timeout);
 	void on_cheat(ServerActiveObject *player, const std::string &cheat_type);
 	bool on_punchplayer(ServerActiveObject *player,
 		ServerActiveObject *hitter, float time_from_last_punch,
diff --git a/src/server.cpp b/src/server.cpp
@@ -2683,7 +2683,7 @@ void Server::DeleteClient(u16 peer_id, ClientDeletionReason reason)
 				PlayerSAO *playersao = player->getPlayerSAO();
 				assert(playersao);
 
-				m_script->on_leaveplayer(playersao);
+				m_script->on_leaveplayer(playersao, reason == CDR_TIMEOUT);
 
 				playersao->disconnected();
 			}

Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,8 @@ void ScriptApiPlayer::on_joinplayer(ServerActiveObject *player)`
`135`	`135`	`runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);`
`136`	`136`	`}`
`137`	`137`
`138`		`-void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player)`
	`138`	`+void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player,`
	`139`	`+ bool timeout)`
`139`	`140`	`{`
`140`	`141`	`SCRIPTAPI_PRECHECKHEADER`
`141`	`142`
`@@ -144,7 +145,8 @@ void ScriptApiPlayer::on_leaveplayer(ServerActiveObject *player)`
`144`	`145`	`lua_getfield(L, -1, "registered_on_leaveplayers");`
`145`	`146`	`// Call callbacks`
`146`	`147`	`objectrefGetOrCreate(L, player);`
`147`		`- runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);`
	`148`	`+ lua_pushboolean(L, timeout);`
	`149`	`+ runCallbacks(2, RUN_CALLBACKS_MODE_FIRST);`
`148`	`150`	`}`
`149`	`151`
`150`	`152`	`void ScriptApiPlayer::on_cheat(ServerActiveObject *player,`
Original file line number	Diff line number	Diff line change
`@@ -2683,7 +2683,7 @@ void Server::DeleteClient(u16 peer_id, ClientDeletionReason reason)`
`2683`	`2683`	`PlayerSAO *playersao = player->getPlayerSAO();`
`2684`	`2684`	`assert(playersao);`
`2685`	`2685`
`2686`		`- m_script->on_leaveplayer(playersao);`
	`2686`	`+ m_script->on_leaveplayer(playersao, reason == CDR_TIMEOUT);`
`2687`	`2687`
`2688`	`2688`	`playersao->disconnected();`
`2689`	`2689`	`}`