Difference between revisions of "SetSoundEffectEnabled"

From Multi Theft Auto: Wiki
(Example)
m (Incorrectly categorized as 'Needs Example'.)
Line 29: Line 29:
 
==See Also==
 
==See Also==
 
{{Client_audio_functions}}
 
{{Client_audio_functions}}
 
[[Category:Needs_Example]]
 

Revision as of 11:01, 25 June 2012

Used to enable or disable specific sound effects.

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

See Also