SetSoundLooped: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
{{Added feature/item|3.0159|1.5.9|1.5.8|20785|This function is used to change the loop option of the [[sound]] [[element]].}}
{{Added feature/item|3.0159|1.5.9|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.}}



Revision as of 09:51, 20 September 2021

20785


[[{{{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.

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