summaryrefslogtreecommitdiff
path: root/doc/menu_lua_api.txt
diff options
context:
space:
mode:
authorWuzzy <wuzzy2@mail.ru>2020-01-08 21:27:54 +0000
committerParamat <paramat@users.noreply.github.com>2020-01-08 21:27:54 +0000
commitf4f7c7a11b74d8102afa6b78822830aea551408a (patch)
treeff384aca9e80a2af9431bff26988924d9c8f57f8 /doc/menu_lua_api.txt
parent7c0e0c34ecb66e044f59cbab03a4c12fc7838e97 (diff)
downloadminetest-f4f7c7a11b74d8102afa6b78822830aea551408a.tar.gz
minetest-f4f7c7a11b74d8102afa6b78822830aea551408a.tar.bz2
minetest-f4f7c7a11b74d8102afa6b78822830aea551408a.zip
Improve Lua API documentation on sounds (#9265)
Diffstat (limited to 'doc/menu_lua_api.txt')
-rw-r--r--doc/menu_lua_api.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt
index cc1e508c3..4861ed0d9 100644
--- a/doc/menu_lua_api.txt
+++ b/doc/menu_lua_api.txt
@@ -244,3 +244,11 @@ Limitations of Async operations
-Limited set of available functions
e.g. No access to functions modifying menu like core.start,core.close,
core.show_path_select_dialog
+
+Background music
+----------------
+The main menu supports background music.
+It looks for a `main_menu` sound in `$USER_PATH/sounds`. The same naming
+conventions as for normal sounds apply.
+This means the player can add a custom sound.
+It will be played in the main menu (gain = 1.0), looped.