SetWorldSoundEnabled

From Multi Theft Auto: Wiki
Revision as of 21:08, 9 September 2012 by Ransom (talk | contribs) (→‎Example: Removed wind example, this function will not turn off wind. See http://bugs.mtasa.com/view.php?id=7304)
Jump to navigation Jump to search

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

This template will be deleted.

See Also