IsSoundLooped

* ADDED IN VERSION 1.5.9 (BETA: 1.5.8 r20785):

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

Minimum supported server version	n/a
Minimum supported client version	1.5.8-9.20785

Note: Using this function/event requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20785" />

IsSoundLooped

Syntax

Required Arguments

Returns

Example

Requirements

See Also

Navigation menu

Search