PlaySound: 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 a [[sound]] element and plays it immediately after creation for the local player. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">element playSound ( string | <syntaxhighlight lang="lua">element playSound ( string soundName, [ 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.) | ||
===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:47, 26 December 2008
Creates a sound element and plays it immediately after creation for the local player.
Syntax
element playSound ( string soundName, [ 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.)
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