Difference between revisions of "SetSoundEffectEnabled"

From Multi Theft Auto: Wiki
m (Incorrectly categorized as 'Needs Example'.)
m
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Client function}}
 
{{Client function}}
Used to enable or disable specific sound effects.
+
Used to enable or disable specific [[sound]] effects.
 
+
{{New feature/item|3.0132|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>  
 
+
{{OOP||[[sound]]:setEffectEnabled}}
 
===Required Arguments===  
 
===Required Arguments===  
*'''sound:''' a [[sound]] element.
+
*'''sound:''' a [[sound]] [[element]].
 
*'''effectName:''' the effect you want to enable or disable
 
*'''effectName:''' the effect you want to enable or disable
 
{{Sound_Effects}}
 
{{Sound_Effects}}
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}}
 +
 +
[[hu:setSoundEffectEnabled]]
 +
[[ar:setSoundEffectEnabled]]
 +
[[RO:setSoundEffectEnabled]]

Latest revision as of 20:49, 8 July 2019

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 )

OOP Syntax Help! I don't understand this!

Method: sound:setEffectEnabled(...)

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