IsSoundPaused: 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}} | ||
This function is used to return the current pause state of the specified [[sound]] element. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool | <syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theSound:''' The [[sound]] element which pause state you want to return. | ||
===Returns=== | ===Returns=== | ||
Returns | Returns ''true'' if the [[sound]] element is paused, ''false'' if unpaused or invalid arguments were passed. | ||
==Example== | ==Example== | ||
Revision as of 20:53, 26 December 2008
This function is used to return the current pause state of the specified sound element.
Syntax
bool isSoundPaused ( element theSound )
Required Arguments
- theSound: The sound element which pause state you want to return.
Returns
Returns true if the sound element is paused, false if unpaused or invalid arguments were passed.
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