IsSoundPaused
From Multi Theft Auto: Wiki
This function is used to return the current pause state of the specified sound element.
If the element is a player, this function will use the players voice.
Syntax
bool isSoundPaused ( element theSound )
OOP Syntax Help! I don't understand this!
- Method: sound:isPaused(...)
- Variable: .paused
- Counterpart: setSoundPaused
Required Arguments
Returns
Returns true if the sound element is paused, false if unpaused or invalid arguments were passed.
Example
This example will check and see if the sound is paused or not, and tell the player.
Click to collapse [-]
ClienttheSound = playSound("music/song.mp3") function checkSongPause() local pause = isSoundPaused(theSound) if(pause == true) then outputChatBox("The sound is paused!") else outputChatBox("The sound is not paused!") end end addCommandHandler("checkpause", checkSongPause)
Changelog
Version | Description |
---|
1.3.2 | Added player element to use a players voice |
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