SetSoundEffectParameter

From Multi Theft Auto: Wiki
Revision as of 16:04, 7 August 2021 by Myonlake (talk | contribs)
Jump to navigation Jump to search

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

Minimum server version n/a
Minimum client version 1.5.8-9.20914

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20914" />

Example

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

See Also