PlaySound3D - Revision history

IManGaaX at 15:14, 2 January 2026

2026-01-02T15:14:59Z

← Older revision		Revision as of 15:14, 2 January 2026
Line 34:		Line 34:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onResourceStart()		function onResourceStart()
	~~local sound =~~ playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)		playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
	end		end
	addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)		addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)
Line 43:		Line 43:
	<section name="Example 2" class="client" show="true" >		<section name="Example 2" class="client" show="true" >
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler('onClientResourceStart', resourceRoot,		addEventHandler('onClientResourceStart', resourceRoot, function()
	function()		local uSound = playSound3D('http://977music.com/itunes/80s.pls', 2498, -1659, 12)
	local uSound = playSound3D('http://977music.com/itunes/80s.pls', 2498, -1659, 12)		if isElement(uSound) then
	setSoundMaxDistance(uSound, 100)		setSoundMaxDistance(uSound, 100)
	end		end
	)		end)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Tracer: Changed syntax

2024-06-17T12:44:32Z

Changed syntax

← Older revision		Revision as of 12:44, 17 June 2024
Line 7:		Line 7:
	*For performance reasons, when using playSound3D 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 playSound3D 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 playSound3D ( string soundPath~~, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>~~		<syntaxhighlight lang="lua">
	~~<syntaxhighlight lang="lua">element playSound3D ( string soundURL~~, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>		element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false, bool throttled = true ] )
			</syntaxhighlight>
	{{OOP\|\|[[Sound\|Sound3D]]}}		{{OOP\|\|[[Sound\|Sound3D]]}}

	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' raw data or [[filepath]] to 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:''' raw data or [[filepath]] to the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)

Fernando187: Fix typo

2023-11-03T16:34:22Z

Fix typo

← Older revision		Revision as of 16:34, 3 November 2023
Line 28:		Line 28:

	==Example==		==Example==
	This example creates a looping sound within a pizza shop. ~~The pizza shop is~~ in ~~san fierro~~ near ~~pier~~ 69		This example creates a looping sound within a pizza shop. It's located in San Fierro near Pier 69.
	<section name="Example" class="client" show="true">		<section name="Example" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Fernando187: Fix typo

2023-11-03T16:33:33Z

Fix typo

← Older revision		Revision as of 16:33, 3 November 2023
Line 37:		Line 37:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	This example ~~play~~ internet radio ~~in groove~~ street.
			This example plays internet radio at Grove street.
	<section name="Example 2" class="client" show="true" >		<section name="Example 2" class="client" show="true" >
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Quadro11: Add FLAC.

2023-04-12T13:34:47Z

Add FLAC.

← Older revision		Revision as of 13:34, 12 April 2023
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 and S3M.		*The only supported audio formats are MP3, WAV, OGG, FLAC, RIFF, MOD, WEBM, XM, IT and S3M.
	*For performance reasons, when using playSound3D 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 playSound3D 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:40, 26 November 2021

2021-11-26T10:40:45Z

← Older revision		Revision as of 10:40, 26 November 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.~~<br />~~		Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.
	~~<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 and S3M.		*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, WEBM, XM, IT and S3M.
	*For performance reasons, when using playSound3D 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 playSound3D 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==
Line 11:		Line 11:
	{{OOP\|\|[[Sound\|Sound3D]]}}		{{OOP\|\|[[Sound\|Sound3D]]}}
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' ~~the~~ [[filepath]] to 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:''' raw data or [[filepath]] to 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}}~~
	*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])		*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])
	*'''x:''' a [[float]]ing point number representing the X coordinate on the map.		*'''x:''' a [[float]]ing point number representing the X coordinate on the map.

Alvesvin at 22:09, 18 August 2021

2021-08-18T22:09:59Z

← Older revision		Revision as of 22:09, 18 August 2021
Line 58:		Line 58:
	[[DE:playSound3D]]		[[DE:playSound3D]]
	[[RU:playSound3D]]		[[RU:playSound3D]]
			[[PT-BR:playSound3D]]

Qaisjp: fix rev

2020-10-10T19:33:17Z

fix rev

← Older revision		Revision as of 19:33, 10 October 2020
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] to 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]] to 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}}
	*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])		*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])
	*'''x:''' a [[float]]ing point number representing the X coordinate on the map.		*'''x:''' a [[float]]ing point number representing the X coordinate on the map.

Zangomangu at 10:29, 3 July 2020

2020-07-03T10:29:30Z

← Older revision		Revision as of 10:29, 3 July 2020
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] to 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]] to 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.
			}}
	*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])		*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])
	*'''x:''' a [[float]]ing point number representing the X coordinate on the map.		*'''x:''' a [[float]]ing point number representing the X coordinate on the map.

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

2020-04-22T15:01:18Z

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

← Older revision		Revision as of 15:01, 22 April 2020
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''soundPath:''' the [[filepath]] to 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]] to the sound file you want to play. ('''Note:''' Playing sound files from other resources requires the target resource to be in the running state)
	*'''soundURL:''' the URL. (In this version the file does not ~~has~~ to be predefined in the [[meta.xml]] )		*'''soundURL:''' the URL (http://, https:// or ftp://) of the sound file you want to play. (In this version the file does not have to be predefined in the [[meta.xml]])
	*'''x:''' a [[float]]ing point number representing the X coordinate on the map.		*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
	*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.		*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.