From Multi Theft Auto: Wiki
Jump to: navigation, 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

Note: This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.

Note: See Also: setAmbientSoundEnabled


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


  • index : An integer representing an individual sound within the group


Returns true if the world sound was correctly enabled/disabled, false if invalid values were passed.


This is a simplified example that lets the client toggle their weapon sounds.

function toggleWeaponSounds_f ( )
    local enabled = isWorldSoundEnabled ( 5 ) -- We place this variable here for checking.
    enabled       = not enabled -- And here we invert (toggle) the variable, so if it's false, it becomes true, if it's true, it becomes false.
    -- Used for the chat declaration:
    local state   = "enabled"

    if ( not enabled ) then
        state = "disabled"

    setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens.
    outputChatBox ( "Weapon sounds " .. state )
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )


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