setWorldSoundEnabled

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

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

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 . If immediate argument is set to false , this function won't affect sounds which are already playing (such as the wind that can only be stopped by entering an interior.) See also: setAmbientSoundEnabled .

Syntax

 setWorldSoundEnabled ( )

Code Examples

client

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 )

setWorldSoundEnabled

Syntax

Code Examples

See Also

World Functions

Reference