SetAmbientSoundEnabled - Revision history

Qaisjp: replace note

2019-09-07T08:40:07Z

replace note

← Older revision		Revision as of 08:40, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{Note box\|See Also: [[setWorldSoundEnabled]]}}~~		This function allows you to disable some background sound effects. See also: [[setWorldSoundEnabled]].

	This function allows you to disable some background sound effects.

	==Syntax==		==Syntax==

Ransom at 17:25, 6 September 2012

2012-09-06T17:25:31Z

← Older revision		Revision as of 17:25, 6 September 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			{{Note box\|See Also: [[setWorldSoundEnabled]]}}

	This function allows you to disable some background sound effects.		This function allows you to disable some background sound effects.

	~~{{Note box\|See Also: [[setWorldSoundEnabled]]}}~~

	==Syntax==		==Syntax==

Ransom: Linked two similar named functions in the notebox until (if?) one is deprecated

2012-09-06T17:25:07Z

Linked two similar named functions in the notebox until (if?) one is deprecated

← Older revision		Revision as of 17:25, 6 September 2012
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function allows you to disable some background sound effects.		This function allows you to disable some background sound effects.

			{{Note box\|See Also: [[setWorldSoundEnabled]]}}

	==Syntax==		==Syntax==

Ccw at 05:36, 11 August 2011

2011-08-11T05:36:30Z

← Older revision		Revision as of 05:36, 11 August 2011
Line 23:		Line 23:

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

Ccw at 05:35, 11 August 2011

2011-08-11T05:35:17Z

← Older revision		Revision as of 05:35, 11 August 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Server client~~ function}}		{{Client function}}
	This function allows you to disable some background sound effects.		This function allows you to disable some background sound effects.

X86dev at 22:29, 30 July 2011

2011-07-30T22:29:07Z

← Older revision		Revision as of 22:29, 30 July 2011
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setAmbientSoundEnabled( string ~~type~~, bool enable )		bool setAmbientSoundEnabled( string theType, bool enable )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~type~~:''' The type of ambient sound to toggle. Can be either "gunfire" or "general".		*'''theType:''' The type of ambient sound to toggle. Can be either "gunfire" or "general".
	*'''enable :''' Set ''false'' to turn off, ''true'' to turn on		*'''enable :''' Set ''false'' to turn off, ''true'' to turn on

Ccw: Created page with "NOTOC {{Server client function}} This function allows you to disable some background sound effects. ==Syntax== bool setAmbientSoundEnabled( string type, bool e..."

2011-07-30T21:24:03Z

Created page with "__NOTOC__ {{Server client function}} This function allows you to disable some background sound effects. ==Syntax== <syntaxhighlight lang="lua"> bool setAmbientSoundEnabled( string type, bool e..."

New page

__NOTOC__
{{Server client function}}
This function allows you to disable some background sound effects.

==Syntax==
<syntaxhighlight lang="lua">
bool setAmbientSoundEnabled( string type, bool enable )
</syntaxhighlight>

===Required Arguments===
*'''type:''' The type of ambient sound to toggle. Can be either "gunfire" or "general".
*'''enable :''' Set ''false'' to turn off, ''true'' to turn on

===Returns===
Returns ''true'' if the ambient sound was set correctly, ''false'' if invalid values were passed.

==Example==
This example turns off the ambient water and gunfire sounds:
<syntaxhighlight lang="lua">
setAmbientSoundEnabled( "general", false )
setAmbientSoundEnabled( "gunfire", false )
</syntaxhighlight>

==See Also==
{{World functions}}