IsSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{Added feature/item|3.0160|1.5.9|1.5.8|20785|This function is used to return the current loop state of the [[sound]] [[element]].}}
{{Added feature/item|1.5.9|1.5.8|20785|This function is used to return the current loop state of the [[sound]] [[element]].}}


==Syntax==  
==Syntax==  
Line 35: Line 35:
end)
end)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20785}}


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[PT-BR:isSoundLooped]]

Latest revision as of 17:24, 7 November 2024

This function is used to return the current loop state 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 looped, false otherwise.

Example

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)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/IsSoundLooped?oldid=81277"