IsSoundLooped: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Added feature/item|3. | {{Added feature/item|3.0160|1.5.9|1.5.8|20785|This function is used to return the current loop state of the [[sound]] [[element]].}} | ||
==Syntax== | ==Syntax== |
Revision as of 12:31, 23 September 2021
20785
Syntax
bool isSoundLooped ( element theSound )
OOP Syntax Help! I don't understand this!
- Method: sound:isLooped(...)
- Counterpart: setSoundLooped
Required Arguments
Returns
Returns true if the sound element is looped, false otherwise.
Example
This will create a sound element and change its state to looped, with a command to switch the loop state and output its state:
local mySound addEventHandler ("onClientResourceStart", resourceRoot, function () mySound = playSound ("sound.mp3") setSoundLooped (mySound, true) end) addCommandHandler ("loop", function () if isElement (mySound) then local newState = not isSoundLooped (mySound) setSoundLooped (mySound, newState) if newState then outputChatBox ("The sound will loop!") else outputChatBox ("The sound will not loop anymore!") end end end)
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
- 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