GetSoundEffects: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
Line 28: | Line 28: | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[ru:getSoundEffects]] | |||
[[ar:getSoundEffects]] | [[ar:getSoundEffects]] | ||
[[de:getSoundEffects]] | [[de:getSoundEffects]] |
Revision as of 18:21, 2 September 2017
Returns the states of all effects of a sound.
Syntax
table getSoundEffects ( element sound )
OOP Syntax Help! I don't understand this!
- Method: sound:getEffects(...)
Required Arguments
- sound: a sound element.
Returns
Returns a table with the effect names as the keys, and their states as the values if successful. Otherwise, it returns false.
Sound effect names:
- gargle
- compressor
- echo
- i3dl2reverb
- distortion
- chorus
- parameq
- reverb
- flanger
Example
function switchEffects(sound) for _,v in ipairs(getSoundEffects(sound)) do -- Go through the whole list of sound effects for the sound if v == "gargle" then -- If the sound effect is 'gargle', proceed setSoundEffectEnabled(sound, "gargle", false) -- Disable the 'gargle' -effect 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