SetWorldSoundEnabled: Difference between revisions

Revision as of 21:35, 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.

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 )

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" />

@@ Line 26: / Line 26: @@
 setWorldSoundEnabled( 40, false )
 </syntaxhighlight>
+==Requirements==
+{{Requirements|n/a|1.3.0-9.04134|}}
 ==See Also==
 {{Client world functions}}