SetSoundEffectParameter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
{{New feature/item|3.0159|1.5.8|20914|This function sets the parameter of a sound effect.}}
{{New feature/item|3.0159|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.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundEffectParameter( element sound, string effectName, string effectParam, var paramValue )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundEffectParameter ( element sound, string effectName, string effectParam, var paramValue )</syntaxhighlight>  
===Required Arguments===
===Required Arguments===
*'''sound''': the sound element.
*'''sound''': the [[sound]] element.
*'''effectName''': the effect name.
*'''effectName''': the effect name.
*'''effectParam''': the parameter name.
*'''effectParam''': the parameter name.

Revision as of 16:04, 7 August 2021

This function sets the parameter of a sound effect.

[[{{{image}}}|link=|]] Note: Using this function on a player voice sound element is not supported at this time.

Syntax

bool setSoundEffectParameter ( element sound, string effectName, string effectParam, var paramValue )

Required Arguments

  • sound: the sound element.
  • effectName: the effect name.
  • effectParam: the parameter name.
  • paramValue: the parameter value.

Returns

Returns true if everything went well, error is raised otherwise.

Parameters

Requirements

This template will be deleted.

Example

Click to collapse [-]
Client
setSoundEffectParameter(sound, "echo", "leftDelay", 500)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundEffectParameter?oldid=71590"