IsSoundLooped

BETA: FROM VERSION 1.5.8 r20785 ONWARDS

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

Syntax

bool isSoundLooped(element theSound)

OOP Syntax Help! I don't understand this!

Method: sound:isLooped(...)

Counterpart: setSoundLooped

Required Arguments

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

Returns

Returns true if the sound element is seted to loop, false otherwise.

Example

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)

See Also

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM

• getSoundBufferLength
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData

BETA: FROM VERSION 1.5.8 r20785 ONWARDS

• isSoundLooped

• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled

BETA: FROM VERSION 1.5.8 r20785 ONWARDS

• setSoundLooped

• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound