SetSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0159|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.}}


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===
==Example==
This example creates a sound element and turn on its looping
This example creates a [[sound]] [[element]] and turn on its looping:
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local mySound = playSound('sound.mp3')
local mySound = playSound ("sound.mp3")
setSoundLooped(mySound, true)
setSoundLooped (mySound, true)
</syntaxhighlight>
</syntaxhighlight>
</section>
 
==Requirements==
{{Requirements|n/a|1.5.8-9.20785}}


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

Latest revision as of 20:42, 23 September 2021

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)

Requirements

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

Note: Using this feature 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" />

See Also


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