IsAmbientSoundEnabled

From Multi Theft Auto: Wiki
Revision as of 09:13, 12 July 2017 by MaK$iM (talk | contribs)
Jump to navigation Jump to search

Accessories-text-editor.png Script Example Missing Function IsAmbientSoundEnabled needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

This function allows you to check if some background sound effects are enabled.

Syntax

bool isAmbientSoundEnabled( string theType )

Required Arguments

  • theType: The type of ambient sound to test. Can be either "gunfire" or "general".

Returns

Returns true if the ambient sound is enabled, false if it is disabled or invalid values were passed.

Example

This command checks if the type of ambient sound is enabled or not. /check <type>

addCommandHandler("check",function(_,_type)
	if isAmbientSoundEnabled(_type) then
		outputChatBox(_type.." is enabled!",0,255,0)
	else
		outputChatBox(_type.." is disabled!",255,0,0)
	end
end)

See Also