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)
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Note box|See Also: [[setWorldSoundEnabled]]}}
This function allows you to disable some background sound effects.
This function allows you to disable some background sound effects.
{{Note box|See Also: [[setWorldSoundEnabled]]}}


==Syntax==
==Syntax==

Revision as of 17:25, 6 September 2012

This template is no longer in use as it results in poor readability.

This function allows you to disable some background sound effects.

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=33164"