SetAmbientSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Linked two similar named functions in the notebox until (if?) one is deprecated)
m (replace note)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
This function allows you to disable some background sound effects.
This function allows you to disable some background sound effects. See also: [[setWorldSoundEnabled]].
 
{{Note box|See Also: [[setWorldSoundEnabled]]}}


==Syntax==
==Syntax==

Latest revision as of 08:40, 7 September 2019

This function allows you to disable some background sound effects. See also: setWorldSoundEnabled.

Syntax

bool setAmbientSoundEnabled( string theType, bool enable )

Required Arguments

  • theType: The type of ambient sound to toggle. Can be either "gunfire" or "general".
  • enable : Set false to turn off, true to turn on

Returns

Returns true if the ambient sound was set correctly, false if invalid values were passed.

Example

This example turns off the ambient water and gunfire sounds: 

setAmbientSoundEnabled( "general", false )
setAmbientSoundEnabled( "gunfire", false )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetAmbientSoundEnabled?oldid=64157"