PlaySound3D

2013-11-10T19:57:04Z

Junior Melo: /* Example */

__NOTOC__
{{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 />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>

===Required Arguments===
*'''soundPath:''' The [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag. And also can use url instead of [[filepath]] )
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)
</syntaxhighlight>
</section>
This example play internet radio in groove street.
<section name="Example 2" class="client" show="true" >
<syntaxhighlight lang="lua">
addEventHandler( 'onClientResourceStart', resourceRoot,
function( )
local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 )
setSoundMaxDistance( uSound, 100 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:playSound3D]]
[[DE:playSound3D]]

Multi Theft Auto: Wiki - User contributions [en]

PlaySound3D