PlaySound3D
From Multi Theft Auto: Wiki
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:
|
Syntax
element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )
element playSound3D ( string soundURL, float x, float y, float z, [ bool looped = false, bool throttled = true ] )
OOP Syntax Help! I don't understand this!
- Method: Sound3D(...)
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)
- soundURL: the URL. (In this version the file does not has to be predefined in the meta.xml )
- 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 (i.e. given reduced download bandwidth). To throttle 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 [-]
Examplefunction onResourceStart() local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) end addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)
This example play internet radio in groove street.
Click to collapse [-]
Example 2addEventHandler('onClientResourceStart', resourceRoot, function() local uSound = playSound3D('http://977music.com/itunes/80s.pls', 2498, -1659, 12) setSoundMaxDistance(uSound, 100) end )
See Also
- getSoundBufferLength
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundPanningEnabled
- isSoundPaused
- playSFX
- playSFX3D
- playSound
- playSound3D
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound