BRNSystems/minetest
1
0
Fork 0
forked from Mirrorlandia_minetest/minetest
Code Pull Requests 1 Activity

Lua_api.txt: Clarify use of looping sounds

Browse Source
This commit is contained in:
paramat 2016-12-01 04:49:17 +00:00
parent 6c9f10e132
commit 105676b952
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/lua_api.txt
View File

@ -441,18 +441,24 @@ from the available ones of the following files:
Examples of sound parameter tables:
-- Play location-less on all clients
-- Play locationless on all clients
{
gain = 1.0, -- default
}
-- Play location-less to a player
-- Play locationless to one player
{
to_player = name,
gain = 1.0, -- default
}
-- Play locationless to one player, looped
{
to_player = name,
gain = 1.0, -- default
loop = true,
}
-- Play in a location
{
pos = {x=1,y=2,z=3},
pos = {x = 1, y = 2, z = 3},
gain = 1.0, -- default
max_hear_distance = 32, -- default, uses an euclidean metric
}
@ -461,15 +467,18 @@ Examples of sound parameter tables:
object = <an ObjectRef>,
gain = 1.0, -- default
max_hear_distance = 32, -- default, uses an euclidean metric
loop = true, -- only sounds connected to objects can be looped
loop = true,
}
Looped sounds must either be connected to an object or played locationless to
one player using `to_player = name,`
### `SimpleSoundSpec`
* e.g. `""`
* e.g. `"default_place_node"`
* e.g. `{}`
* e.g. `{name="default_place_node"}`
* e.g. `{name="default_place_node", gain=1.0}`
* e.g. `{name = "default_place_node"}`
* e.g. `{name = "default_place_node", gain = 1.0}`
Registered definitions of stuff
-------------------------------