SetSoundEffectEnabled: Difference between revisions

Revision as of 04:08, 6 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

@@ Line 35: / Line 35: @@
 ==See Also==
 {{Client_audio_functions}}
+[[AR:setSoundEffectEnabled]]