IsSoundLooped: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{ | {{Added feature/item|1.5.9|1.5.8|20785|This function is used to return the current loop state of the [[sound]] [[element]].}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool isSoundLooped(element theSound)</syntaxhighlight> | <syntaxhighlight lang="lua">bool isSoundLooped ( element theSound )</syntaxhighlight> | ||
{{OOP||[[sound]]:isLooped||setSoundLooped}} | {{OOP||[[sound]]:isLooped||setSoundLooped}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 10: | Line 10: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the [[sound]] [[element]] is | Returns ''true'' if the [[sound]] [[element]] is looped, ''false'' otherwise. | ||
==Example== | ==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: | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local mySound | local mySound | ||
addEventHandler( | |||
mySound = playSound( | addEventHandler ("onClientResourceStart", resourceRoot, function () | ||
setSoundLooped(mySound, true) | mySound = playSound ("sound.mp3") | ||
setSoundLooped (mySound, true) | |||
end) | end) | ||
addCommandHandler( | addCommandHandler ("loop", function () | ||
if isElement(mySound) then | if isElement (mySound) then | ||
local newState = not isSoundLooped(mySound) | local newState = not isSoundLooped (mySound) | ||
setSoundLooped(mySound, newState) | setSoundLooped (mySound, newState) | ||
if newState then | if newState then | ||
outputChatBox( | outputChatBox ("The sound will loop!") | ||
else | else | ||
outputChatBox( | outputChatBox ("The sound will not loop anymore!") | ||
end | end | ||
end | end | ||
| Line 35: | Line 38: | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
Latest revision as of 17:24, 7 November 2024
This function is used to return the current loop state of the sound element.
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)
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