SetSoundLooped: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{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]].}} | ||
{{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 14: | Line 14: | ||
Returns ''true'' if the [[sound]] [[element]] loop was successfully changed, ''false'' otherwise. | Returns ''true'' if the [[sound]] [[element]] loop was successfully changed, ''false'' otherwise. | ||
==Example== | |||
This example creates a sound element and turn on its looping | This example creates a [[sound]] [[element]] and turn on its looping: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local mySound = playSound( | local mySound = playSound ("sound.mp3") | ||
setSoundLooped(mySound, true) | setSoundLooped (mySound, true) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Requirements== | |||
{{Requirements|n/a|1.5.8-9.20785}} | |||
==See Also== | ==See Also== | ||
Revision as of 09:51, 20 September 2021
20785
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
This template will be deleted.
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd