[CSM] sound_play & sound_stop support + client_lua_api doc (#5096)

* squashed: CSM: Implement register_globalstep
  * Re-use fatal error mechanism from server to disconnect client on CSM error
  * Little client functions cleanups

* squashed: CSM: add core.after function
  * core.after is shared code between client & server
  * ModApiUtil get_us_time feature enabled for client

src/client.cpp

@@ -263,6 +263,7 @@ Client::Client(
 		g_settings->getBool("enable_parallax_occlusion"));
 
 	m_script = new ClientScripting(this);
+	m_env.setScript(m_script);
 }
 
 void Client::initMods()

src/client.h

@@ -488,13 +488,19 @@ public:
 	// Get event from queue. CE_NONE is returned if queue is empty.
 	ClientEvent getClientEvent();
 
-	bool accessDenied()
-	{ return m_access_denied; }
+	bool accessDenied() const { return m_access_denied; }
 
-	bool reconnectRequested() { return m_access_denied_reconnect; }
+	bool reconnectRequested() const { return m_access_denied_reconnect; }
 
-	std::string accessDeniedReason()
-	{ return m_access_denied_reason; }
+	void setFatalError(const std::string &reason)
+	{
+		m_access_denied = true;
+		m_access_denied_reason = reason;
+	}
+
+	// Renaming accessDeniedReason to better name could be good as it's used to
+	// disconnect client when CSM failed.
+	const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 
 	bool itemdefReceived()
 	{ return m_itemdef_received; }

src/clientenvironment.cpp

@@ -22,6 +22,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "clientenvironment.h"
 #include "clientsimpleobject.h"
 #include "clientmap.h"
+#include "clientscripting.h"
 #include "mapblock_mesh.h"
 #include "event.h"
 #include "collision.h"
@@ -42,6 +43,7 @@ ClientEnvironment::ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr,
 	m_smgr(smgr),
 	m_texturesource(texturesource),
 	m_client(client),
+	m_script(NULL),
 	m_irr(irr)
 {
 	char zero = 0;
@@ -243,6 +245,8 @@ void ClientEnvironment::step(float dtime)
 		}
 	}
 
+	m_script->environment_step(dtime);
+
 	/*
 		A quick draft of lava damage
 	*/

src/clientenvironment.h

@@ -27,6 +27,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 class ClientSimpleObject;
 class ClientMap;
+class ClientScripting;
 class ClientActiveObject;
 class GenericCAO;
 class LocalPlayer;
@@ -75,6 +76,7 @@ public:
 	ClientMap & getClientMap();
 
 	Client *getGameDef() { return m_client; }
+	void setScript(ClientScripting *script) { m_script = script; }
 
 	void step(f32 dtime);
 
@@ -176,6 +178,7 @@ private:
 	scene::ISceneManager *m_smgr;
 	ITextureSource *m_texturesource;
 	Client *m_client;
+	ClientScripting *m_script;
 	IrrlichtDevice *m_irr;
 	UNORDERED_MAP<u16, ClientActiveObject*> m_active_objects;
 	std::vector<ClientSimpleObject*> m_simple_objects;

src/guiEngine.h

@@ -139,6 +139,7 @@ private:
 class GUIEngine {
 	/** grant ModApiMainMenu access to private members */
 	friend class ModApiMainMenu;
+	friend class ModApiSound;
 
 public:
 	/**

src/script/clientscripting.cpp

@@ -22,6 +22,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "client.h"
 #include "cpp_api/s_internal.h"
 #include "lua_api/l_client.h"
+#include "lua_api/l_sound.h"
 #include "lua_api/l_util.h"
 
 ClientScripting::ClientScripting(Client *client):
@@ -51,4 +52,5 @@ void ClientScripting::InitializeModApi(lua_State *L, int top)
 {
 	ModApiUtil::InitializeClient(L, top);
 	ModApiClient::Initialize(L, top);
+	ModApiSound::Initialize(L, top);
 }

src/script/cpp_api/s_client.cpp

@@ -20,6 +20,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "s_client.h"
 #include "s_internal.h"
+#include "client.h"
 
 void ScriptApiClient::on_shutdown()
 {
@@ -94,3 +95,20 @@ void ScriptApiClient::on_death()
 	// Call callbacks
 	runCallbacks(0, RUN_CALLBACKS_MODE_FIRST);
 }
+
+void ScriptApiClient::environment_step(float dtime)
+{
+	SCRIPTAPI_PRECHECKHEADER
+
+	// Get core.registered_globalsteps
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "registered_globalsteps");
+	// Call callbacks
+	lua_pushnumber(L, dtime);
+	try {
+		runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);
+	} catch (LuaError &e) {
+		getClient()->setFatalError(std::string("Client environment_step: ") + e.what() + "\n"
+				+ script_get_backtrace(L));
+	}
+}

src/script/cpp_api/s_client.h

@@ -36,5 +36,7 @@ public:
 	void on_damage_taken(int32_t damage_amount);
 	void on_hp_modification(int32_t newhp);
 	void on_death();
+
+	void environment_step(float dtime);
 };
 #endif

src/script/lua_api/CMakeLists.txt

@@ -25,4 +25,5 @@ set(common_SCRIPT_LUA_API_SRCS
 set(client_SCRIPT_LUA_API_SRCS
 	${CMAKE_CURRENT_SOURCE_DIR}/l_client.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/l_mainmenu.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/l_sound.cpp
 	PARENT_SCOPE)

src/script/lua_api/l_client.h

@@ -23,7 +23,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "lua_api/l_base.h"
 
-class ModApiClient : public ModApiBase
+class ModApiClient:
+	public ModApiBase
 {
 private:
 	// get_current_modname()

src/script/lua_api/l_mainmenu.cpp

@@ -32,9 +32,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "convert_json.h"
 #include "serverlist.h"
 #include "mapgen.h"
-#include "sound.h"
 #include "settings.h"
-#include "log.h"
 #include "EDriverTypes.h"
 
 #include <IFileArchive.h>
@@ -962,33 +960,6 @@ int ModApiMainMenu::l_show_file_open_dialog(lua_State *L)
 	return 0;
 }
 
-/******************************************************************************/
-int ModApiMainMenu::l_sound_play(lua_State *L)
-{
-	GUIEngine* engine = getGuiEngine(L);
-
-	SimpleSoundSpec spec;
-	read_soundspec(L, 1, spec);
-	bool looped = lua_toboolean(L, 2);
-
-	u32 handle = engine->playSound(spec, looped);
-
-	lua_pushinteger(L, handle);
-
-	return 1;
-}
-
-/******************************************************************************/
-int ModApiMainMenu::l_sound_stop(lua_State *L)
-{
-	GUIEngine* engine = getGuiEngine(L);
-
-	u32 handle = luaL_checkinteger(L, 1);
-	engine->stopSound(handle);
-
-	return 1;
-}
-
 /******************************************************************************/
 int ModApiMainMenu::l_download_file(lua_State *L)
 {
@@ -1160,8 +1131,6 @@ void ModApiMainMenu::Initialize(lua_State *L, int top)
 	API_FCT(download_file);
 	API_FCT(get_modstore_details);
 	API_FCT(get_modstore_list);
-	API_FCT(sound_play);
-	API_FCT(sound_stop);
 	API_FCT(gettext);
 	API_FCT(get_video_drivers);
 	API_FCT(get_video_modes);

src/script/lua_api/l_mainmenu.h

@@ -25,7 +25,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 class AsyncEngine;
 
 /** Implementation of lua api support for mainmenu */
-class ModApiMainMenu : public ModApiBase {
+class ModApiMainMenu: public ModApiBase
+{
 
 private:
 	/**
@@ -79,10 +80,6 @@ private:
 
 	static int l_delete_favorite(lua_State *L);
 
-	static int l_sound_play(lua_State *L);
-
-	static int l_sound_stop(lua_State *L);
-
 	static int l_gettext(lua_State *L);
 
 	//gui

src/script/lua_api/l_sound.cpp

@@ -0,0 +1,62 @@
+/*
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#include "l_sound.h"
+#include "l_internal.h"
+#include "common/c_content.h"
+#include "guiEngine.h"
+
+
+int ModApiSound::l_sound_play(lua_State *L)
+{
+	SimpleSoundSpec spec;
+	read_soundspec(L, 1, spec);
+	bool looped = lua_toboolean(L, 2);
+
+	s32 handle;
+	if (Client *client = getClient(L))
+		handle = client->getSoundManager()->playSound(spec, looped);
+	// Main menu doesn't have access to client, use guiEngine
+	else
+		handle = getGuiEngine(L)->playSound(spec, looped);
+
+	lua_pushinteger(L, handle);
+
+	return 1;
+}
+
+int ModApiSound::l_sound_stop(lua_State *L)
+{
+	u32 handle = luaL_checkinteger(L, 1);
+
+	if (Client *client = getClient(L))
+		client->getSoundManager()->stopSound(handle);
+	// Main menu doesn't have access to client, use guiEngine
+	else
+		getGuiEngine(L)->stopSound(handle);
+
+	return 1;
+}
+
+void ModApiSound::Initialize(lua_State *L, int top)
+{
+	API_FCT(sound_play);
+	API_FCT(sound_stop);
+}

src/script/lua_api/l_sound.h

@@ -0,0 +1,36 @@
+/*
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#ifndef L_SOUND_H_
+#define L_SOUND_H_
+
+#include "lua_api/l_base.h"
+
+
+class ModApiSound: public ModApiBase
+{
+private:
+	static int l_sound_play(lua_State *L);
+	static int l_sound_stop(lua_State *L);
+public:
+	static void Initialize(lua_State *L, int top);
+};
+
+#endif

src/script/lua_api/l_util.cpp

@@ -530,6 +530,8 @@ void ModApiUtil::InitializeClient(lua_State *L, int top)
 {
 	API_FCT(log);
 
+	API_FCT(get_us_time);
+
 	API_FCT(setting_set);
 	API_FCT(setting_get);
 	API_FCT(setting_setbool);

src/script/scripting_mainmenu.cpp

@@ -19,11 +19,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "scripting_mainmenu.h"
 #include "mods.h"
-#include "porting.h"
-#include "log.h"
 #include "cpp_api/s_internal.h"
 #include "lua_api/l_base.h"
 #include "lua_api/l_mainmenu.h"
+#include "lua_api/l_sound.h"
 #include "lua_api/l_util.h"
 #include "lua_api/l_settings.h"
 
@@ -63,6 +62,7 @@ void MainMenuScripting::initializeModApi(lua_State *L, int top)
 	// Initialize mod API modules
 	ModApiMainMenu::Initialize(L, top);
 	ModApiUtil::Initialize(L, top);
+	ModApiSound::Initialize(L, top);
 
 	// Register reference classes (userdata)
 	LuaSettings::Register(L);