Pair: setSoundLooped

This function is used to return the current loop state of the sound element.

OOP Syntax Help! I don't understand this!

• Method: sound:isLooped(...)
• Variable: .looped

Syntax

bool isSoundLooped ( sound theSound )

Required Arguments

• theSound: The sound element which you want to get the loop state.

Returns

• bool: result

Returns true if the sound element is looped, false otherwise.

Code Examples

Example 1 Example 2 (OOP)

client

This will create a sound element and change its state to looped, with a command to switch the loop state and output its state.

local mySound

addEventHandler ("onClientResourceStart", resourceRoot, function ()
    mySound = playSound ("sound.mp3")
    setSoundLooped (mySound, true)
end)

addCommandHandler ("loop", function ()
    if isElement (mySound) then
        local newState = not isSoundLooped (mySound)
        setSoundLooped (mySound, newState)

        if newState then
            outputChatBox ("The sound will loop!")
        else
            outputChatBox ("The sound will not loop anymore!")
        end
    end
end)

client

OOP Required

This will create a sound element and change its state to looped, with a command to switch the loop state and output its state.

local mySound

addEventHandler ("onClientResourceStart", resourceRoot, function ()
    mySound = Sound ("sound.mp3")
    mySound.looped = true
end)

addCommandHandler ("loop", function ()
    if isElement (mySound) then
        local newState = not mySound.looped
        mySound.looped = newState

        if newState then
            outputChatBox ("The sound will loop!")
        else
            outputChatBox ("The sound will not loop anymore!")
        end
    end
end)

See Also

Audio Functions

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM
• getSoundEffectParameters
• getSoundBufferLength
• getSoundEffects
• getSoundFFTData
• getSoundLevelData
• getSoundLength
• getSoundMaxDistance
• getSoundMinDistance
• getSoundMetaTags
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundLooped
• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• setRadioChannel
• setSoundEffectEnabled
• setSoundEffectParameter
• setSoundLooped
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPosition
• setSoundProperties
• setSoundPaused
• setSoundSpeed
• setSoundVolume
• stopSound

Audio Elements

• sound

Reference

• Scripting Functions