SetSoundEffectParameter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(OOP)
Line 5: Line 5:


==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>
{{OOP||[[sound]]:setEffectParameter}}
===Required Arguments===
===Required Arguments===
*'''sound''': the [[sound]] element.
*'''sound''': the [[sound]] element.

Revision as of 11:07, 9 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 )

OOP Syntax Help! I don't understand this!

Method: sound:setEffectParameter(...)


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