isWorldSoundEnabled | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

isWorldSoundEnabled

Client-side
Server-side
Shared
Needs checking

This function was partially migrated from the old wiki. Please review manually:

  • Missing section: OptionalArguments

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function allows you to check if certain world sound effects have not been disabled by setWorldSoundEnabled

Syntax

bool isWorldSoundEnabled ( int group, [ int index = -1 ] )
Required Arguments
  • group: MISSING_PARAM_DESC
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • index (default: -1): MISSING_PARAM_DESC

Returns

  • bool: value

Returns true if the world sounds are enabled, false if they are disabled or invalid values were passed.

Code Examples

shared

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


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

See Also

World Functions
Reference