IsWorldSoundEnabled

From Multi Theft Auto: Wiki

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

OptionalArguments

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

Returns

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

Example

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 )

Requirements

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

Retrieved from "https://wiki.multitheftauto.com/index.php?title=IsWorldSoundEnabled&oldid=50802"