StopSound: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 14: | Line 14: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local sound | |||
function startMySound() | function startMySound() | ||
sound = playSound( "sound.mp3", true ) | sound = playSound("sound.mp3", true) | ||
end | end | ||
addEventHandler( "onClientResourceStart", resourceRoot, startMySound ) | addEventHandler("onClientResourceStart", resourceRoot, startMySound) | ||
function stopMySound() | function stopMySound() | ||
stopSound( sound ) | if isElement(sound) then | ||
stopSound(sound) | |||
end | |||
end | end | ||
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound | addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[HU:stopSound]] | |||
[[AR:stopSound]] | [[AR:stopSound]] | ||
[[RO:stopSound]] | |||
Latest revision as of 15:16, 2 January 2026
Stops the sound playback for specified sound element. The sound element is also destroyed.
Syntax
bool stopSound ( element theSound )
OOP Syntax Help! I don't understand this!
- Method: sound:stop(...)
Required Arguments
Returns
Returns true if the sound was successfully stopped, false otherwise.
Example
local sound
function startMySound()
sound = playSound("sound.mp3", true)
end
addEventHandler("onClientResourceStart", resourceRoot, startMySound)
function stopMySound()
if isElement(sound) then
stopSound(sound)
end
end
addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound
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