SetWorldSoundEnabled - Revision history

Srslyyyy: Update misleading note

2025-01-09T22:27:53Z

Update misleading note

← Older revision		Revision as of 22:27, 9 January 2025
Line 5:		Line 5:
	{{Note\|		{{Note\|
	*The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound\|showsound]] in conjunction with [[setDevelopmentMode]].		*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.		*If '''immediate''' argument is set to '''false''', this function won't affect sounds which are already playing (such as the wind that can only be stopped by entering an interior.)
	* See also: [[setAmbientSoundEnabled]].}}		* See also: [[setAmbientSoundEnabled]].}}

Fernando187: Remove obsolete Requirements section

2024-11-07T17:04:29Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:04, 7 November 2024
Line 64:		Line 64:
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.0-9.04134\|}}~~

	==Changelog==		==Changelog==

Lvrent at 16:35, 20 September 2021

2021-09-20T16:35:52Z

← Older revision		Revision as of 16:35, 20 September 2021
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\|		{{Note\|
	*The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound\|showsound]] in conjunction with [[setDevelopmentMode]]		*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.		*This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.
	* See also: [[setAmbientSoundEnabled]]}}		* See also: [[setAmbientSoundEnabled]].}}

	==Syntax==		==Syntax==
Line 14:		Line 14:

	===Required Arguments===		===Required Arguments===
	*'''group:''' An [[int\|integer]] representing the [[World sound groups\|world sound group]]		*'''group:''' An [[int\|integer]] representing the [[World sound groups\|world sound group]].
	*'''enable:''' Set to ''false'' to disable, ''true'' to enable		*'''enable:''' Set to ''false'' to disable, ''true'' to enable.

	===Optional Arguments===		===Optional Arguments===

Pirulax: /* Example */

2020-06-30T15:55:11Z

Example

@@ Line 42: / Line 42: @@
      setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens.
      outputChatBox ( "Weapon sounds " .. state )
 end
 addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )

Qaisjp: merge notes

2019-09-07T08:41:05Z

merge notes

← Older revision		Revision as of 08:41, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{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]].		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\|		{{Note\|
	*The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound\|showsound]] in conjunction with [[setDevelopmentMode]]		*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.}}		*This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.
			* See also: [[setAmbientSoundEnabled]]}}

	==Syntax==		==Syntax==

Zver-CR at 10:44, 9 November 2018

2018-11-09T10:44:19Z

← Older revision		Revision as of 10:44, 9 November 2018
Line 56:		Line 56:
	==Requirements==		==Requirements==
	{{Requirements\|n/a\|1.3.0-9.04134\|}}		{{Requirements\|n/a\|1.3.0-9.04134\|}}

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.5.5-9.11860\|Added immediate argument}}

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

Myonlake: /* Example */

2018-08-01T14:28:07Z

Example

← Older revision		Revision as of 14:28, 1 August 2018
Line 45:		Line 45:
	</syntaxhighlight>		</syntaxhighlight>

	{{New feature/item\|9.0156\|1.5.6\|11860\|		{{New feature/item\|3.0156\|1.5.5\|11860\|
	This example disables the wind sound effect immediately without changing the interior afterwards.		This example disables the wind sound effect immediately without changing the interior afterwards.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Myonlake: /* Optional Arguments */

2018-08-01T14:27:50Z

Optional Arguments

← Older revision		Revision as of 14:27, 1 August 2018
Line 18:		Line 18:
	===Optional Arguments===		===Optional Arguments===
	*'''index:''' An [[int\|integer]] representing an individual sound within the group		*'''index:''' An [[int\|integer]] representing an individual sound within the group
	{{New feature/item\|9.0156\|1.5.6\|11860\|		{{New feature/item\|3.0156\|1.5.5\|11860\|
	*'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.		*'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.
	}}		}}

Myonlake at 17:25, 30 July 2018

2018-07-30T17:25:14Z

← Older revision		Revision as of 17:25, 30 July 2018
Line 13:		Line 13:

	===Required Arguments===		===Required Arguments===
	*'''group:''' An [[integer]] representing the [[World sound groups\|world sound group]]		*'''group:''' An [[int\|integer]] representing the [[World sound groups\|world sound group]]
	*'''enable:''' Set to ''false'' to disable, ''true'' to enable		*'''enable:''' Set to ''false'' to disable, ''true'' to enable

	===Optional Arguments===		===Optional Arguments===
	*'''index:''' An [[integer]] representing an individual sound within the group		*'''index:''' An [[int\|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\|
	*'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.		*'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.

Myonlake: /* Syntax */

2018-07-30T17:24:52Z

Syntax

← Older revision		Revision as of 17:24, 30 July 2018
Line 9:		Line 9:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable [, bool immediate = false ] )		bool setWorldSoundEnabled ( int group, [ int index = -1, ] bool enable [, bool immediate = false ] )
	</syntaxhighlight>		</syntaxhighlight>