SetSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (add "see also")
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 change the loop option of the [[sound]] [[element]].}}
{{New feature/item|3.0159|1.5.8|20785|This function is used to change the loop option 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===  

Revision as of 11:20, 11 April 2021

This function is used to change the loop option 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 was successfully changed, false otherwise.

addEventHandler('onClientResourceStart', resourceRoot, function()
    local mySound = playSound('sound.mp3')
    setSoundLooped(mySound, true)
end)

See Also