setSoundLooped
Client-side
Server-side
Shared
Pair: isSoundLooped
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.
OOP Syntax Help! I don't understand this!
- Method: sound:setLooped(...)
- Variable: .looped
Syntax
bool setSoundLooped ( sound theSound, bool loop )Required Arguments
- theSound: The sound element to set the loop.
- loop: A boolean representing whether the sound will be looped.
Returns
- bool: result
Returns true if the sound element loop state was successfully changed, false otherwise.
Code Examples
client
This example creates a sound element and turn on its looping.
local mySound = playSound ("sound.mp3")setSoundLooped (mySound, true)See Also
Audio Functions
- getSFXStatus
- getRadioChannel
- getSoundBPM
- getSoundBufferLength
- getRadioChannelName
- getSoundEffectParameters
- getSoundFFTData
- getSoundEffects
- getSoundLevelData
- getSoundMetaTags
- getSoundPan
- getSoundMinDistance
- getSoundMaxDistance
- getSoundPosition
- getSoundLength
- getSoundProperties
- getSoundVolume
- getSoundSpeed
- getSoundWaveData
- isSoundPanningEnabled
- playSFX3D
- isSoundPaused
- playSFX
- isSoundLooped
- playSound
- playSound3D
- setRadioChannel
- setSoundEffectEnabled
- setSoundLooped
- setSoundMaxDistance
- setSoundEffectParameter
- setSoundPan
- setSoundMinDistance
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound