SetSoundLooped
Jump to navigation
Jump to search
This function is used to change the loop state of the sound element.
| Note: If the sound element is destroyed by destroyElement the loop will not happen. |
Syntax
bool setSoundLooped ( element theSound, bool loop )
OOP Syntax Help! I don't understand this!
- Method: sound:setLooped(...)
- Counterpart: isSoundLooped
Required Arguments
- theSound: The sound element to set the loop.
- bool: A boolean representing whether the sound will be looped.
Returns
Returns true if the sound element loop state was successfully changed, false otherwise.
Example
This example creates a sound element and turn on its looping:
local mySound = playSound ("sound.mp3")
setSoundLooped (mySound, true)
Requirements
| Minimum server version | n/a |
|---|---|
| Minimum client version | 1.5.8-9.20785 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20785" />
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
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound