PlaySound - Revision history

IManGaaX at 15:13, 2 January 2026

2026-01-02T15:13:40Z

← Older revision		Revision as of 15:13, 2 January 2026
Line 27:		Line 27:
	local sound = playSound("sounds/wasted.mp3") -- Play wasted.mp3 from the sounds folder		local sound = playSound("sounds/wasted.mp3") -- Play wasted.mp3 from the sounds folder
	if isElement(sound) then		if isElement(sound) then
	setSoundVolume(sound, 0.5) -- Set the sound volume to 50%		setSoundVolume(sound, 0.5) -- Set the sound volume to 50%
	end		end
	end		end

IManGaaX at 15:13, 2 January 2026

2026-01-02T15:13:15Z

← Older revision		Revision as of 15:13, 2 January 2026
Line 25:		Line 25:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function wasted (killer, weapon, bodypart)		function wasted (killer, weapon, bodypart)
	local sound = playSound("sounds/wasted.mp3") -- Play wasted.mp3 from the sounds folder		local sound = playSound("sounds/wasted.mp3") -- Play wasted.mp3 from the sounds folder
	setSoundVolume(sound, 0.5) -- Set the sound volume to 50%		if isElement(sound) then
			setSoundVolume(sound, 0.5) -- Set the sound volume to 50%
			end
	end		end

Quadro11: Add FLAC.

2022-12-22T18:33:04Z

Add FLAC.

← Older revision		Revision as of 18:33, 22 December 2022
Line 4:		Line 4:
	{{Added feature/item\|1.6.0\|1.5.9\|21034\|Added the feature of playing WebM files.}}		{{Added feature/item\|1.6.0\|1.5.9\|21034\|Added the feature of playing WebM files.}}
	{{Note\|		{{Note\|
	*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, WEBM, XM, IT, S3M and PLS (e.g. Webstream).		*The only supported audio formats are MP3, WAV, OGG, FLAC, RIFF, MOD, WEBM, XM, IT, S3M and PLS (e.g. Webstream).
	*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}		*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
	==Syntax==		==Syntax==

Lvrent at 10:38, 26 November 2021

2021-11-26T10:38:39Z

← Older revision		Revision as of 10:38, 26 November 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.~~<br />~~		Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.
	~~<br~~ />		{{Added feature/item\|1.6.0\|1.5.9\|21034\|Added the feature of playing WebM files.}}
	{{Note\|		{{Note\|
	*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS (e.g. Webstream).		*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, WEBM, XM, IT, S3M and PLS (e.g. Webstream).
	*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}		*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>		<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
	{{OOP\|\|[[Sound]]}}		{{OOP\|\|[[Sound]]}}
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' ~~the~~ [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)		*'''soundPath:''' [[filepath]], raw data or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
	~~{{New items\|5.0157\|1.5.7\|~~
	*'''soundPath:''' Can also be raw sound data.
	~~\|20460}}~~

	===Optional Arguments===		===Optional Arguments===
Line 28:		Line 25:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function wasted (killer, weapon, bodypart)		function wasted (killer, weapon, bodypart)
	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder		local sound = playSound("sounds/wasted.mp3") -- Play wasted.mp3 from the sounds folder
	setSoundVolume(sound, 0.5) -- ~~set~~ the sound volume to 50%		setSoundVolume(sound, 0.5) -- Set the sound volume to 50%
	end		end

	addEventHandler("onClientPlayerWasted", localPlayer, wasted) --~~add~~ the event handler		addEventHandler("onClientPlayerWasted", localPlayer, wasted) -- Add the event handler
	</syntaxhighlight>		</syntaxhighlight>

Alvesvin at 02:00, 18 August 2021

2021-08-18T02:00:58Z

← Older revision		Revision as of 02:00, 18 August 2021
Line 41:		Line 41:
	[[DE:playSound]]		[[DE:playSound]]
	[[RO:playSound]]		[[RO:playSound]]
			[[PT-BR:playSound]]

Qaisjp: fix rev

2020-10-10T19:33:31Z

fix rev

← Older revision		Revision as of 19:33, 10 October 2020
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)		*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
	{{New items\|5.0157\|1.5.7~~-9.20460~~\|		{{New items\|5.0157\|1.5.7\|
	*'''soundPath:''' Can also be raw sound data.		*'''soundPath:''' Can also be raw sound data.
	}}		\|20460}}

	===Optional Arguments===		===Optional Arguments===

Zangomangu at 10:28, 3 July 2020

2020-07-03T10:28:41Z

← Older revision		Revision as of 10:28, 3 July 2020
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)		*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
			{{New items\|5.0157\|1.5.7-9.20460\|
			*'''soundPath:''' Can also be raw sound data.
			}}

	===Optional Arguments===		===Optional Arguments===

-ffs-Sniper: add info about supported URL protocols, especially ftp://

2020-04-22T14:54:20Z

add info about supported URL protocols, especially ftp://

← Older revision		Revision as of 14:54, 22 April 2020
Line 10:		Line 10:
	{{OOP\|\|[[Sound]]}}		{{OOP\|\|[[Sound]]}}
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)		*'''soundPath:''' the [[filepath]] or URL (http://, https:// or ftp://) of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)

	===Optional Arguments===		===Optional Arguments===

Danilo at 04:34, 11 August 2019

2019-08-11T04:34:55Z

← Older revision		Revision as of 04:34, 11 August 2019
Line 3:		Line 3:
	Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />		Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
	<br />		<br />
	~~'''~~Note~~:'''~~ The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).		{{Note\|
	~~{{Note\|~~For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}		*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS (e.g. Webstream).
			*For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>		<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>

Botder: Changed misleading parameter description

2019-06-29T00:53:30Z

Changed misleading parameter description

← Older revision		Revision as of 00:53, 29 June 2019
Line 9:		Line 9:
	{{OOP\|\|[[Sound]]}}		{{OOP\|\|[[Sound]]}}
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (~~Sound specified by filepath has~~ to be ~~predefined~~ in the ~~[[meta.xml]] file with <file /> tag.~~)		*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)

	===Optional Arguments===		===Optional Arguments===