Implement minetest.sound_fade()

sfan5 · nerzhul · commit 5f3a17eb65c1 · 2020-04-11T13:12:51.000+02:00
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt
@@ -734,6 +734,13 @@ Call these functions only at load time!
     * `spec` is a `SimpleSoundSpec`
     * `parameters` is a sound parameter table
 * `minetest.sound_stop(handle)`
+    * `handle` is a handle returned by `minetest.sound_play`
+* `minetest.sound_fade(handle, step, gain)`
+    * `handle` is a handle returned by `minetest.sound_play`
+    * `step` determines how fast a sound will fade.
+      Negative step will lower the sound volume, positive step will increase
+      the sound volume.
+    * `gain` the target gain for the fade.
 
 ### Timing
 * `minetest.after(time, func, ...)`
diff --git a/src/script/lua_api/l_client.cpp b/src/script/lua_api/l_client.cpp
@@ -209,7 +209,7 @@ int ModApiClient::l_gettext(lua_State *L)
 	return 1;
 }
 
-// get_node(pos)
+// get_node_or_nil(pos)
 // pos = {x=num, y=num, z=num}
 int ModApiClient::l_get_node_or_nil(lua_State *L)
 {
@@ -228,6 +228,7 @@ int ModApiClient::l_get_node_or_nil(lua_State *L)
 	return 1;
 }
 
+// get_langauge()
 int ModApiClient::l_get_language(lua_State *L)
 {
 #ifdef _WIN32
@@ -244,6 +245,7 @@ int ModApiClient::l_get_language(lua_State *L)
 	return 2;
 }
 
+// get_wielded_item()
 int ModApiClient::l_get_wielded_item(lua_State *L)
 {
 	Client *client = getClient(L);
@@ -266,12 +268,14 @@ int ModApiClient::l_get_meta(lua_State *L)
 	return 1;
 }
 
+// sound_play(spec, parameters)
 int ModApiClient::l_sound_play(lua_State *L)
 {
 	ISoundManager *sound = getClient(L)->getSoundManager();
 
 	SimpleSoundSpec spec;
 	read_soundspec(L, 1, spec);
+
 	float gain = 1.0f;
 	float pitch = 1.0f;
 	bool looped = false;
@@ -293,21 +297,32 @@ int ModApiClient::l_sound_play(lua_State *L)
 		}
 	}
 
-	handle = sound->playSound(spec.name, looped, gain * spec.gain, 0.0f, pitch);
+	handle = sound->playSound(spec.name, looped, gain * spec.gain, spec.fade, pitch);
 	lua_pushinteger(L, handle);
 
 	return 1;
 }
 
+// sound_stop(handle)
 int ModApiClient::l_sound_stop(lua_State *L)
 {
-	u32 handle = luaL_checkinteger(L, 1);
+	s32 handle = luaL_checkinteger(L, 1);
 
 	getClient(L)->getSoundManager()->stopSound(handle);
 
 	return 0;
 }
 
+// sound_fade(handle, step, gain)
+int ModApiClient::l_sound_fade(lua_State *L)
+{
+	s32 handle = luaL_checkinteger(L, 1);
+	float step = readParam<float>(L, 2);
+	float gain = readParam<float>(L, 3);
+	getClient(L)->getSoundManager()->fadeSound(handle, step, gain);
+	return 0;
+}
+
 // get_server_info()
 int ModApiClient::l_get_server_info(lua_State *L)
 {
@@ -426,6 +441,7 @@ void ModApiClient::Initialize(lua_State *L, int top)
 	API_FCT(get_meta);
 	API_FCT(sound_play);
 	API_FCT(sound_stop);
+	API_FCT(sound_fade);
 	API_FCT(get_server_info);
 	API_FCT(get_item_def);
 	API_FCT(get_node_def);
diff --git a/src/script/lua_api/l_client.h b/src/script/lua_api/l_client.h
@@ -69,6 +69,7 @@ class ModApiClient : public ModApiBase
 	// get_node(pos)
 	static int l_get_node_or_nil(lua_State *L);
 
+	// get_language()
 	static int l_get_language(lua_State *L);
 
 	// get_wielded_item()
@@ -77,10 +78,15 @@ class ModApiClient : public ModApiBase
 	// get_meta(pos)
 	static int l_get_meta(lua_State *L);
 
+	// sound_play(spec, parameters)
 	static int l_sound_play(lua_State *L);
 
+	// sound_stop(handle)
 	static int l_sound_stop(lua_State *L);
 
+	// sound_fade(handle, step, gain)
+	static int l_sound_fade(lua_State *L);
+
 	// get_server_info()
 	static int l_get_server_info(lua_State *L);
 
diff --git a/src/script/lua_api/l_nodemeta.cpp b/src/script/lua_api/l_nodemeta.cpp
@@ -55,11 +55,13 @@ Metadata* NodeMetaRef::getmeta(bool auto_create)
 
 void NodeMetaRef::clearMeta()
 {
+	SANITY_CHECK(!m_is_local);
 	m_env->getMap().removeNodeMetadata(m_p);
 }
 
 void NodeMetaRef::reportMetadataChange(const std::string *name)
 {
+	SANITY_CHECK(!m_is_local);
 	// NOTE: This same code is in rollback_interface.cpp
 	// Inform other things that the metadata has changed
 	NodeMetadata *meta = dynamic_cast<NodeMetadata*>(m_meta);

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ int ModApiClient::l_gettext(lua_State *L)`
`209`	`209`	`return 1;`
`210`	`210`	`}`
`211`	`211`
`212`		`-// get_node(pos)`
	`212`	`+// get_node_or_nil(pos)`
`213`	`213`	`// pos = {x=num, y=num, z=num}`
`214`	`214`	`int ModApiClient::l_get_node_or_nil(lua_State *L)`
`215`	`215`	`{`
`@@ -228,6 +228,7 @@ int ModApiClient::l_get_node_or_nil(lua_State *L)`
`228`	`228`	`return 1;`
`229`	`229`	`}`
`230`	`230`
	`231`	`+// get_langauge()`
`231`	`232`	`int ModApiClient::l_get_language(lua_State *L)`
`232`	`233`	`{`
`233`	`234`	`#ifdef _WIN32`
`@@ -244,6 +245,7 @@ int ModApiClient::l_get_language(lua_State *L)`
`244`	`245`	`return 2;`
`245`	`246`	`}`
`246`	`247`
	`248`	`+// get_wielded_item()`
`247`	`249`	`int ModApiClient::l_get_wielded_item(lua_State *L)`
`248`	`250`	`{`
`249`	`251`	`Client *client = getClient(L);`
`@@ -266,12 +268,14 @@ int ModApiClient::l_get_meta(lua_State *L)`
`266`	`268`	`return 1;`
`267`	`269`	`}`
`268`	`270`
	`271`	`+// sound_play(spec, parameters)`
`269`	`272`	`int ModApiClient::l_sound_play(lua_State *L)`
`270`	`273`	`{`
`271`	`274`	`ISoundManager *sound = getClient(L)->getSoundManager();`
`272`	`275`
`273`	`276`	`SimpleSoundSpec spec;`
`274`	`277`	`read_soundspec(L, 1, spec);`
	`278`	`+`
`275`	`279`	`float gain = 1.0f;`
`276`	`280`	`float pitch = 1.0f;`
`277`	`281`	`bool looped = false;`
`@@ -293,21 +297,32 @@ int ModApiClient::l_sound_play(lua_State *L)`
`293`	`297`	`}`
`294`	`298`	`}`
`295`	`299`
`296`		`- handle = sound->playSound(spec.name, looped, gain * spec.gain, 0.0f, pitch);`
	`300`	`+ handle = sound->playSound(spec.name, looped, gain * spec.gain, spec.fade, pitch);`
`297`	`301`	`lua_pushinteger(L, handle);`
`298`	`302`
`299`	`303`	`return 1;`
`300`	`304`	`}`
`301`	`305`
	`306`	`+// sound_stop(handle)`
`302`	`307`	`int ModApiClient::l_sound_stop(lua_State *L)`
`303`	`308`	`{`
`304`		`- u32 handle = luaL_checkinteger(L, 1);`
	`309`	`+ s32 handle = luaL_checkinteger(L, 1);`
`305`	`310`
`306`	`311`	`getClient(L)->getSoundManager()->stopSound(handle);`
`307`	`312`
`308`	`313`	`return 0;`
`309`	`314`	`}`
`310`	`315`
	`316`	`+// sound_fade(handle, step, gain)`
	`317`	`+int ModApiClient::l_sound_fade(lua_State *L)`
	`318`	`+{`
	`319`	`+ s32 handle = luaL_checkinteger(L, 1);`
	`320`	`+ float step = readParam<float>(L, 2);`
	`321`	`+ float gain = readParam<float>(L, 3);`
	`322`	`+ getClient(L)->getSoundManager()->fadeSound(handle, step, gain);`
	`323`	`+ return 0;`
	`324`	`+}`
	`325`	`+`
`311`	`326`	`// get_server_info()`
`312`	`327`	`int ModApiClient::l_get_server_info(lua_State *L)`
`313`	`328`	`{`
`@@ -426,6 +441,7 @@ void ModApiClient::Initialize(lua_State *L, int top)`
`426`	`441`	`API_FCT(get_meta);`
`427`	`442`	`API_FCT(sound_play);`
`428`	`443`	`API_FCT(sound_stop);`
	`444`	`+ API_FCT(sound_fade);`
`429`	`445`	`API_FCT(get_server_info);`
`430`	`446`	`API_FCT(get_item_def);`
`431`	`447`	`API_FCT(get_node_def);`
Original file line number	Diff line number	Diff line change
`@@ -55,11 +55,13 @@ Metadata* NodeMetaRef::getmeta(bool auto_create)`
`55`	`55`
`56`	`56`	`void NodeMetaRef::clearMeta()`
`57`	`57`	`{`
	`58`	`+ SANITY_CHECK(!m_is_local);`
`58`	`59`	`m_env->getMap().removeNodeMetadata(m_p);`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`void NodeMetaRef::reportMetadataChange(const std::string *name)`
`62`	`63`	`{`
	`64`	`+ SANITY_CHECK(!m_is_local);`
`63`	`65`	`// NOTE: This same code is in rollback_interface.cpp`
`64`	`66`	`// Inform other things that the metadata has changed`
`65`	`67`	`NodeMetadata meta = dynamic_cast<NodeMetadata>(m_meta);`