PlaySound3D: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add link to RU page.)
(OOP)
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 />
<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>  
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>  
 
{{OOP||[[Sound|Sound3D]].create}}
===Required Arguments===  
===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]] )
*'''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.
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.


===Optional Arguments===  
===Optional Arguments===  
Line 19: Line 19:


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


==Example==  
==Example==  

Revision as of 17:08, 17 October 2014

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.

Note: The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

Syntax

element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )

OOP Syntax Help! I don't understand this!

Method: Sound3D.create(...)


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

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • 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

Click to collapse [-]
Example
function onResourceStart()
	local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) 
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)

This example play internet radio in groove street.

Click to collapse [-]
Example 2
addEventHandler( 'onClientResourceStart', resourceRoot,
	function( )
		local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 ) 
		setSoundMaxDistance( uSound, 100 )
	end
)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/PlaySound3D?oldid=42649"