GetSoundEffects: Difference between revisions
Jump to navigation
Jump to search
(Created page with '__NOTOC__ {{Client function}} Returns the states of all effects of a sound. ==Syntax== <syntaxhighlight lang="lua">int getSoundEffects ( element sound )</syntaxhighlight> ===Required Arguments=== *'…') |
mNo edit summary |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">table getSoundEffects ( element sound )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 16:53, 9 August 2010
Returns the states of all effects of a sound.
Syntax
table getSoundEffects ( element sound )
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
-- TODO
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