SetSoundEffectEnabled: Difference between revisions
Jump to navigation
Jump to search
m (Incorrectly categorized as 'Needs Example'.) |
No edit summary |
||
| Line 2: | Line 2: | ||
{{Client function}} | {{Client function}} | ||
Used to enable or disable specific sound effects. | Used to enable or disable specific sound effects. | ||
{{New_feature|3.0139|1.3.2| | |||
Use a player element to control a players voice with this function. | |||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool bEnable )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool bEnable )</syntaxhighlight> | ||
| Line 26: | Line 28: | ||
end,true) --set it case sensitive as we are going to get the command name and use it in the setSoundEffectEnabled | end,true) --set it case sensitive as we are going to get the command name and use it in the setSoundEffectEnabled | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.3.2|Added player element for voice control}} | |||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
Revision as of 22:45, 4 May 2013
Used to enable or disable specific sound effects. Use a player element to control a players voice with this function.
Syntax
bool setSoundEffectEnabled ( element sound, string effectName, bool bEnable )
Required Arguments
- sound: a sound element.
- effectName: the effect you want to enable or disable
- gargle
- compressor
- echo
- i3dl2reverb
- distortion
- chorus
- parameq
- reverb
- flanger
- bEnable: 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
This example creates a sound and set's the flanger sound effect enabled.
addCommandHandler("flanger",function(cmd,enabled)
if(isElement(waterSplashes))then
setSoundEffectEnabled(waterSplashes,cmd,enabled)
else
waterSplashes = playSound("splashes.mp3",true)
setSoundEffectEnabled(waterSplashes,cmd,enabled)
end
end,true) --set it case sensitive as we are going to get the command name and use it in the setSoundEffectEnabled
Changelog
| Version | Description |
|---|
| 1.3.2 | Added player element for voice control |
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