SetSoundEffectParameter: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0159|1.5.8|20921|This function sets parameter of sound effect.}} ==Syntax== <syntaxhighlight lang="lua">bool setSoundEffe...") |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item|3.0159|1.5.8| | {{New feature/item|3.0159|1.5.8|20914|This function sets parameter of sound effect.}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setSoundEffectParameter( element sound, string effectName, string effectParam, var | <syntaxhighlight lang="lua">bool setSoundEffectParameter( element sound, string effectName, string effectParam, var paramValue )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound''': the sound. | *'''sound''': the sound element. | ||
*'''effectName''': the effect. | *'''effectName''': the effect name. | ||
*'''effectParam''': the parameter. | *'''effectParam''': the parameter name. | ||
*''' | *'''paramValue''': the parameter value. | ||
===Returns=== | ===Returns=== | ||
| Line 15: | Line 15: | ||
===Parameters=== | ===Parameters=== | ||
<!-- | <!-- Effects parameters --> | ||
==Requirements== | ==Requirements== | ||
{{Requirements|n/a|1.5.8-9. | {{Requirements|n/a|1.5.8-9.20914|}} | ||
==Example== | ==Example== | ||
<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) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Revision as of 13:36, 7 August 2021
This function sets parameter of sound effect.
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 [-]
ClientsetSoundEffectParameter(sound, "echo", "leftDelay", 500)
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound