Difference between revisions of "SetWorldSoundEnabled"

From Multi Theft Auto: Wiki
m
m (Example: Removed wind example, this function will not turn off wind. See http://bugs.mtasa.com/view.php?id=7304)
Line 24: Line 24:
  
 
==Example==  
 
==Example==  
This example turns off car engine sounds, maybe
+
This example turns off car engine sounds
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
setWorldSoundEnabled( 40, false )
 
setWorldSoundEnabled( 40, false )
</syntaxhighlight>
 
 
This example turns off the annoying wind sound that is always heard
 
<syntaxhighlight lang="lua">
 
setWorldSoundEnabled( 0, false, 0 )
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 21:08, 9 September 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.

Note: The values for group and index can be determined by using the client command showsound in conjunction with setDevelopmentMode

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

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

setWorldSoundEnabled( 40, false )

Requirements

Minimum supported server n/a
Minimum supported client 1.3.0-9.04134

Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04134" />

See Also

BETA: FROM VERSION 1.5.7 r20450 ONWARDS