SetSoundEffectParameter - Revision history

Eznemgergo: Clarified using method

2025-03-08T14:25:49Z

Clarified using method

@@ Line 21: / Line 21: @@
 ==Example==
 <syntaxhighlight lang="lua">
 local sound = playSound3D ("music.mp3", 0, 0, 10)

Fernando187: Remove obsolete Requirements section

2024-11-07T17:27:43Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:27, 7 November 2024
Line 28:		Line 28:
	setSoundEffectParameter (sound, "echo", "feedback", 30)		setSoundEffectParameter (sound, "echo", "feedback", 30)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.5.8-9.20914\|}}~~

	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

SaintsTalles: /* Required Arguments */

2023-11-01T22:45:55Z

Required Arguments

← Older revision		Revision as of 22:45, 1 November 2023
Line 8:		Line 8:
	{{OOP\|\|[[sound]]:setEffectParameter}}		{{OOP\|\|[[sound]]:setEffectParameter}}
	===Required Arguments===		===Required Arguments===
	*'''sound''': The [[sound]] element.		*'''sound:''' The [[sound]] element.
	*'''effectName''': The name of the effect whose parameter you want to change:		*'''effectName:''' The name of the effect whose parameter you want to change:
	{{Sound_Effects}}		{{Sound_Effects}}
	*'''effectParam''': The parameter [[#Effects Parameters\|name]].		*'''effectParam:''' The parameter [[#Effects Parameters\|name]].
	*'''paramValue''': The parameter [[#Effects Parameters\|value]].		*'''paramValue:''' The parameter [[#Effects Parameters\|value]].

	===Returns===		===Returns===
	Returns ''true'' if effect have been set successfully, ''false'' otherwise.		Returns ''true'' if effect have been set successfully, ''false'' otherwise.

Lvrent at 20:53, 23 September 2021

2021-09-23T20:53:20Z

← Older revision		Revision as of 20:53, 23 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{Added feature/item~~\|3.0160~~\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}		{{Added feature/item\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}
	{{Note\|Using this function on a player voice sound element is not supported at this time.}}		{{Note\|Using this function on a player voice sound element is not supported at this time.}}

Lvrent at 12:44, 23 September 2021

2021-09-23T12:44:14Z

← Older revision		Revision as of 12:44, 23 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{Added feature/item\|3.~~0159~~\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}		{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}
	{{Note\|Using this function on a player voice sound element is not supported at this time.}}		{{Note\|Using this function on a player voice sound element is not supported at this time.}}

Line 33:		Line 33:
	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

	~~[[PT-BR:setSoundEffectParameter]]~~

Lvrent at 16:42, 20 September 2021

2021-09-20T16:42:45Z

← Older revision		Revision as of 16:42, 20 September 2021
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}		{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}

	{{Note\|Using this function on a player voice sound element is not supported at this time.}}		{{Note\|Using this function on a player voice sound element is not supported at this time.}}

Lvrent at 10:33, 20 September 2021

2021-09-20T10:33:23Z

← Older revision		Revision as of 10:33, 20 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{~~New~~ feature/item\|3.0159\|1.5.8\|20914\|This function sets the parameter of a sound effect.}}		{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20914\|This function sets the parameter of a [[sound]] effect.}}

	{{Note\|Using this function on a player voice sound element is not supported at this time.}}		{{Note\|Using this function on a player voice sound element is not supported at this time.}}

Line 8:		Line 9:
	{{OOP\|\|[[sound]]:setEffectParameter}}		{{OOP\|\|[[sound]]:setEffectParameter}}
	===Required Arguments===		===Required Arguments===
	*'''sound''': ~~the~~ [[sound]] element.		*'''sound''': The [[sound]] element.
	*'''effectName''': ~~the~~ name of the effect whose parameter you want to change.		*'''effectName''': The name of the effect whose parameter you want to change:
	{{Sound_Effects}}		{{Sound_Effects}}
	*'''effectParam''': ~~the~~ parameter [[#Effects Parameters\|name]].		*'''effectParam''': The parameter [[#Effects Parameters\|name]].
	*'''paramValue''': ~~the~~ parameter [[#Effects Parameters\|value]].		*'''paramValue''': The parameter [[#Effects Parameters\|value]].
	===Returns===		===Returns===
	Returns '''true''' if ~~everything went well~~, ~~error is raised~~ otherwise.		Returns ''true'' if effect have been set successfully, ''false'' otherwise.

	===Effects Parameters===		===Effects Parameters===
	{{Sound_Effects_Parameters}}		{{Sound_Effects_Parameters}}

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.5.8-9.20914\|}}~~

	==Example==		==Example==
	~~<section name="Client" class="client" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local sound = playSound3D("music.mp3", 0, 0, 10)		local sound = playSound3D ("music.mp3", 0, 0, 10)
	setSoundEffectEnabled(sound, "echo", true)
	setSoundEffectParameter(sound, "echo", "wetDryMix", 80)		setSoundEffectEnabled (sound, "echo", true)
	setSoundEffectParameter(sound, "echo", "feedback", 30)		setSoundEffectParameter (sound, "echo", "wetDryMix", 80)
			setSoundEffectParameter (sound, "echo", "feedback", 30)
	</syntaxhighlight>		</syntaxhighlight>
	</~~section>~~
			==Requirements==
			{{Requirements\|n/a\|1.5.8-9.20914\|}}

	==See Also==		==See Also==

Alvesvin at 01:45, 19 August 2021

2021-08-19T01:45:12Z

← Older revision		Revision as of 01:45, 19 August 2021
Line 34:		Line 34:
	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

			[[PT-BR:setSoundEffectParameter]]

StrixG: StrixG moved page User:StrixG/SetSoundEffectParameter to SetSoundEffectParameter

2021-08-09T14:32:52Z

StrixG moved page User:StrixG/SetSoundEffectParameter to SetSoundEffectParameter

← Older revision

Revision as of 14:32, 9 August 2021

StrixG at 14:31, 9 August 2021

2021-08-09T14:31:57Z

← Older revision		Revision as of 14:31, 9 August 2021
Line 25:		Line 25:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setSoundEffectParameter(sound, "echo", "~~leftDelay~~", ~~500~~)		local sound = playSound3D("music.mp3", 0, 0, 10)
			setSoundEffectEnabled(sound, "echo", true)
			setSoundEffectParameter(sound, "echo", "wetDryMix", 80)
			setSoundEffectParameter(sound, "echo", "feedback", 30)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>