SetSoundEffectEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool toggle )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool bEnable )</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
Line 10: Line 10:
*'''effectName:''' the effect you want to enable or disable
*'''effectName:''' the effect you want to enable or disable
{{Sound_Effects}}
{{Sound_Effects}}
*'''toggle:''' ''true'' if you want to enable the effect, ''false'' if you want to disable it.
*'''bEnable:''' ''true'' if you want to enable the effect, ''false'' if you want to disable it.


===Returns===
===Returns===

Revision as of 12:04, 21 November 2010

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

-- TODO

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundEffectEnabled?oldid=24555"