StopSound: 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}} | ||
Stops | Stops the sound playback for specified [[sound]] element. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool stopSound ( element | <syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theSound:''' The [[sound]] element you want to stop playing. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise. | Returns ''true'' if the sound was successfully stopped, ''false'' otherwise. | ||
==Example== | ==Example== | ||
Revision as of 20:48, 26 December 2008
Stops the sound playback for specified sound element.
Syntax
bool stopSound ( element theSound )
Required Arguments
- theSound: The sound element you want to stop playing.
Returns
Returns true if the sound was successfully stopped, 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
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd