SetWorldSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by playSound or [[playSoun...")
 
mNo edit summary
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setWorldSoundEnabled( int group, [ int index, ] bool enable )
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable )
</syntaxhighlight>  
</syntaxhighlight>  



Revision as of 17:16, 19 May 2012

This function allows you to disable world sounds. A world sound is a sound effect which has not been caused by playSound or playSound3D.

Syntax

bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable )

Required Arguments

  • group : An integer representing the world sound group
  • enable : Set false to disable, true to enable

OptionalArguments

  • index : An integer representing an individual sound within the group

Returns

Returns true if the world sound was correctly enabled/disabled, false if invalid values were passed.

Example

This example turns off car engine sounds, maybe

setWorldSoundEnabled( 40, false )

See Also