minetest.sound_play

This page contains unofficial, low-quality Lua API documentation and is likely to be outdated or wrong. Do not rely on it! For the official and up-to-date documentation, see Lua API Documentation.

This page has been proposed for deletion for the following reason: "Contains unofficial and potentially outdated, redundant and inconsistent Lua API information" If you don't think that this page should be deleted, please explain why on the talk page.

Language:	[[::minetest.sound play|English]]

Syntax

minetest.sound_play(SimpleSoundSpec, SoundParameters)

Description

Plays a sound.

Only Ogg Vorbis files are supported. For positional playing of sounds, only single-channel (mono) files are supported. Otherwise OpenAL will play them non-positionally.

SimpleSoundSpec can be a string with the filename (without the file extention) or a table with the fields name="name" and gain=float.

SoundParameters is a table with the following fields:

• gain = float: the gain. default = 1.0
• max_hear_distance = int: the maximum hear distance. default = 32
• loop = bool: Sound is looped. Only sounds connected to objects can be looped. default = false

The location can be specified with one of the following fields in the SoundParameters (if none is used, its played locationless to all players):

• to_player = "playername": Sound is played locationless to the player
• pos = position: Sound is played at this position
• object = ObjectRef: Sound is played connected to the object

The function returns a sound handle that can be passed to minetest.sound_stop(handle) to stop the sound.

Features

You can play random sound using filename convention modname_soundname.N.ogg (see examples)

Examples

Plays the testmod_testsound.ogg sound at the position 0,0,0.

minetest.sound_play("testmod_testsound", {
	pos = {x=0, y=0, z=0},
	max_hear_distance = 100,
	gain = 10.0,
})

Plays the testmod_foobar.ogg sound to player "foo".

minetest.sound_play("testmod_foobar", {
	to_player = "foo",
	gain = 2.0,
})

Plays random testmod_foobar sound.

-- testmod/sounds listing:
--	/testmod_foobar.1.ogg
--	/testmod_foobar.2.ogg
--	/testmod_foobar.3.ogg
minetest.sound_play("testmod_foobar")