SetWorldSoundEnabled: Difference between revisions

Revision as of 17:22, 30 July 2018

This template is no longer in use as it results in poor readability. This function allows you to disable world sounds. A world sound is a sound effect which has not been caused by playSound or playSound3D.

[[{{{image}}}\|link=\|]]	Note: The values for group and index can be determined by using the client command showsound in conjunction with setDevelopmentMode This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.

Syntax

bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable [, bool immediate = false ] )

Required Arguments

group : An integer representing the world sound group
enable : Set false to disable, true to enable

Optional Arguments

index : An integer representing an individual sound within the group

ADDED/UPDATED IN VERSION 1.5.6 r11860:

immediate: Boolean if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.

Returns

Returns true if the world sound was correctly enabled/disabled, false if 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 )

ADDED/UPDATED IN VERSION 1.5.6 r11860:

This example disables the wind sound effect immediately without changing the interior afterwards.

setWorldSoundEnabled(0, 0, false, true)
setWorldSoundEnabled(0, 29, false, true)
setWorldSoundEnabled(0, 30, false, true)

Requirements

This template will be deleted.

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-{{New items|3.0131|1.3.1|
+{{Note box|See Also: [[setAmbientSoundEnabled]]}}
 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 [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]
+*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|The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]}}
-{{Note|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 box|See Also: [[setAmbientSoundEnabled]]}}
 ==Syntax==
 <syntaxhighlight lang="lua">