SetWorldSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Info about new argument)
mNo edit summary
Line 4: Line 4:
This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]].
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]]
{{Note|The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|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|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.}}
}}
}}


Line 12: Line 12:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable, [ bool forceCancel = false ] )
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable [, bool immediate = false ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 22: Line 22:
*'''index :''' An integer representing an individual sound within the group
*'''index :''' An integer representing an individual sound within the group
{{New feature/item|9.0156|1.5.6|11860|
{{New feature/item|9.0156|1.5.6|11860|
*'''forceCancel :''' Boolean if set to true will cancel the sound if it's already playing.
*'''immediate:''' Boolean if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.
}}
}}


Line 47: Line 47:
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )
</syntaxhighlight>
</syntaxhighlight>
{{New feature/item|9.0156|1.5.6|11860|
This example disables the wind sound effect immediately without changing the interior afterwards.
<syntaxhighlight lang="lua">
setWorldSoundEnabled(0, 0, false, true)
setWorldSoundEnabled(0, 29, false, true)
setWorldSoundEnabled(0, 30, false, true)
</syntaxhighlight>
}}


==Requirements==
==Requirements==

Revision as of 16:29, 21 February 2018

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
[[{{{image}}}|link=|]] 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.

This template is no longer in use as it results in poor readability.

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

OptionalArguments

  • 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.

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetWorldSoundEnabled?oldid=54025"