aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorExeVirus <44562154+ExeVirus@users.noreply.github.com>2021-11-22 12:26:46 -0500
committerGitHub <noreply@github.com>2021-11-22 17:26:46 +0000
commit52bfbf6ed02e16d11f353c4066a0f4129d045e15 (patch)
tree67b71be5c3b2eda54d0ac05fa23231d6daaf19ba /doc
parente35cfa589a11bbfbdbe9c815553842b472da2b41 (diff)
downloadminetest-52bfbf6ed02e16d11f353c4066a0f4129d045e15.tar.gz
minetest-52bfbf6ed02e16d11f353c4066a0f4129d045e15.tar.bz2
minetest-52bfbf6ed02e16d11f353c4066a0f4129d045e15.zip
Allow for Game-Specific Menu Music (#11241)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 3b9f4c339..efc9585e4 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -113,8 +113,16 @@ If you want to specify multiple images for one identifier, add additional
images named like `$identifier.$n.png`, with an ascending number $n starting
with 1, and a random image will be chosen from the provided ones.
+Menu music
+-----------
+Games can provide custom main menu music. They are put inside a `menu`
+directory inside the game directory.
+The music files are named `theme.ogg`.
+If you want to specify multiple music files for one game, add additional
+images named like `theme.$n.ogg`, with an ascending number $n starting
+with 1 (max 10), and a random music file will be chosen from the provided ones.
Mods
====
@@ -5642,6 +5650,8 @@ Sounds
player actions (e.g. door closing).
* `minetest.sound_stop(handle)`
* `handle` is a handle returned by `minetest.sound_play`
+* `minetest.sound_stop_all()`
+ Stops all currently playing non-ephermeral sounds.
* `minetest.sound_fade(handle, step, gain)`
* `handle` is a handle returned by `minetest.sound_play`
* `step` determines how fast a sound will fade.