PlaySound3D: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 17: Line 17:
{{OptionalArg}}  
{{OptionalArg}}  
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}


===Returns===
===Returns===

Revision as of 11:35, 25 May 2015

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.

[[{{{image}}}|link=|]] Note: 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

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.
  • throttled: a boolean representing whether the sound will be throttled. To throttle the sound, use true. Sounds will be throttled per default and only for URLs.

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(), 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