IsSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Add Example header)
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to return the current loop option of the [[sound]] [[element]].}}
{{New feature/item|3.0159|1.5.8|20785|This function is used to return the current loop option of the [[sound]] [[element]].}}


==Syntax==  
==Syntax==  

Revision as of 11:24, 11 April 2021

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