IsSoundLooped: Difference between revisions

Revision as of 20:42, 23 September 2021

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)

Requirements

This template will be deleted.

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{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==
@@ Line 41: / Line 41: @@
 ==See Also==
 {{Client_audio_functions}}
-[[PT-BR:isSoundLooped]]