PlaySound3D: Difference between revisions
Jump to navigation
Jump to search
Cazomino05 (talk | contribs) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
Creates | 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. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">element playSound3D ( string | <syntaxhighlight lang="lua">element playSound3D ( string soundName, float x, float y, float z, [ bool looped ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''soundName:''' Name of the sound file you want to play. (Sound file has to be predefined in the client side [[meta.xml]] file with <file /> tags.) | ||
*'''x:''' A floating point number representing the X coordinate on the map. | *'''x:''' A floating point number representing the X coordinate on the map. | ||
*'''y:''' A floating point number representing the Y coordinate on the map. | *'''y:''' A floating point number representing the Y coordinate on the map. | ||
| Line 14: | Line 14: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''looped:''' | *'''looped:''' A [[boolean]] representing whether the sound will be looping or not. To loop the sound, use ''true''. | ||
===Returns=== | ===Returns=== | ||
Returns a sound element if the sound was successfully | Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise. | ||
==Example== | ==Example== | ||
Revision as of 20:46, 26 December 2008
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.
Syntax
element playSound3D ( string soundName, float x, float y, float z, [ bool looped ] )
Required Arguments
- soundName: Name of the sound file you want to play. (Sound file has to be predefined in the client side meta.xml file with <file /> tags.)
- 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 looping or not. To loop the sound, use true.
Returns
Returns a sound element if the sound was successfully created, false otherwise.
Example
TODO
Click to collapse [-]
Client--TODO
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound