SetWorldSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Another Example)
Line 25: Line 25:
<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 10:00, 3 June 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

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 )

This example turns off the annoying wind sound that is always heard

setWorldSoundEnabled( 0, false, 0 )

Requirements

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

Note: Using this feature 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