SetSoundEffectEnabled: Difference between revisions
Jump to navigation
Jump to search
(Created page with '__NOTOC__ {{Client function}} Used to enable or disable specific sound effects. ==Syntax== <syntaxhighlight lang="lua">int setSoundEffectEnabled ( element sound, string effectName, bool togg…') |
mNo edit summary |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool toggle )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 16:53, 9 August 2010
Used to enable or disable specific sound effects.
Syntax
bool setSoundEffectEnabled ( element sound, string effectName, bool toggle )
Required Arguments
- sound: a sound element.
- effectName: the effect you want to enable or disable
- gargle
- compressor
- echo
- i3dl2reverb
- distortion
- chorus
- parameq
- reverb
- flanger
- toggle: true if you want to enable the effect, false if you want to disable it.
Returns
Returns true if the effect was set successfully, false otherwise.
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