SetSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to change the loop option of the [[sound]] [[element]].}}
{{Added feature/item|1.5.9|1.5.8|20785|This function is used to change the loop state of the [[sound]] [[element]].}}
{{Note|If the [[sound]] [[element]] is destroyed by [[destroyElement]] the loop will not happen.}}
{{Note|If the [[sound]] [[element]] is destroyed by [[destroyElement]] the loop will not happen.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundLooped(element theSound, bool loop)</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundLooped ( element theSound, bool loop )</syntaxhighlight>  
{{OOP||[[sound]]:setLooped||isSoundLooped}}
{{OOP||[[sound]]:setLooped||isSoundLooped}}
===Required Arguments===  
===Required Arguments===  
Line 12: Line 12:


===Returns===
===Returns===
Returns ''true'' if the [[sound]] [[element]] loop was successfully changed, ''false'' otherwise.
Returns ''true'' if the [[sound]] [[element]] loop state was successfully changed, ''false'' otherwise.


==Example==
This example creates a [[sound]] [[element]] and turn on its looping:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local mySound = playSound ("sound.mp3")
    local mySound = playSound('sound.mp3')
setSoundLooped (mySound, true)
    setSoundLooped(mySound, true)
end)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{Client_audio_functions}}

Latest revision as of 17:24, 7 November 2024

This function is used to change the loop state of the sound element.

[[{{{image}}}|link=|]] Note: If the sound element is destroyed by destroyElement the loop will not happen.

Syntax

bool setSoundLooped ( element theSound, bool loop )

OOP Syntax Help! I don't understand this!

Method: sound:setLooped(...)
Counterpart: isSoundLooped


Required Arguments

  • theSound: The sound element to set the loop.
  • bool: A boolean representing whether the sound will be looped.

Returns

Returns true if the sound element loop state was successfully changed, false otherwise.

Example

This example creates a sound element and turn on its looping: 

local mySound = playSound ("sound.mp3")
setSoundLooped (mySound, true)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundLooped?oldid=81276"