SetWorldSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Another Example)
m (Linked two similar named functions in the notebox until (if?) one is deprecated)
Line 6: Line 6:
Note: The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]
Note: The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]
}}
}}
{{Note box|See Also: [[setAmbientSoundEnabled]]}}
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 17:24, 6 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, maybe 

setWorldSoundEnabled( 40, false )

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

setWorldSoundEnabled( 0, false, 0 )

Requirements

This template will be deleted.

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetWorldSoundEnabled?oldid=33162"