IsWorldSoundEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function allows you to check if certain world sound effects have not been disabled by setWorldSoundEnabled ==Syntax== <syntaxhighlight lang="lua"> bool i...")
 
(Remove obsolete Requirements section)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{New items|3.0140|1.3.1|
{{Client function}}
{{Client function}}
This function allows you to check if certain world sound effects have not been disabled by [[setWorldSoundEnabled]]
This function allows you to check if certain world sound effects have not been disabled by [[setWorldSoundEnabled]]
 
}}
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isWorldSoundEnabled( int group, [ int index ] )
bool isWorldSoundEnabled( int group, [ int index = -1 ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''group :''' An integer representing the world sound group
*'''group :''' An integer representing the [[World sound groups|world sound group]]


===OptionalArguments===  
===OptionalArguments===  
Line 16: Line 17:
===Returns===
===Returns===
Returns ''true'' if the world sounds are enabled, ''false'' if they are disabled or invalid values were passed.
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.
<syntaxhighlight lang="lua">
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 )
</syntaxhighlight>


==See Also==
==See Also==
{{Client world functions}}
{{Client world functions}}

Latest revision as of 17:04, 7 November 2024

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 )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/IsWorldSoundEnabled?oldid=81119"