StopSound: Difference between revisions
Jump to navigation
Jump to search
(OOP) |
|||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
Stops the sound playback for specified [[sound]] element. The sound element is also destroyed. | Stops the sound playback for specified [[sound]] ]]element]]. The sound element is also destroyed. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight> | <syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight> | ||
{{OOP||[[sound]]:stop}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theSound:''' | *'''theSound:''' the [[sound]] [[element]] you want to stop playing. | ||
===Returns=== | ===Returns=== |
Revision as of 17:29, 17 October 2014
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
Click to collapse [-]
Clientfunction startMySound() sound = playSound( "sound.mp3", true ) end addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), startMySound ) function stopMySound() stopSound( sound ) 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