GetSoundEffectParameters: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
===Returns=== | ===Returns=== | ||
Returns | Returns a [[table]] with the parameter names as the keys, and their values. If the specified effect name is not valid, an error is raised. | ||
===Parameters=== | ===Parameters=== | ||
<!-- Effects parameters --> | <!-- Effects parameters --> | ||
Revision as of 14:02, 7 August 2021
This function gets parameters of a sound effect.
Syntax
table getSoundEffectParameters( element sound, string effectName )
Required Arguments
- sound: the sound element.
- effectName: the effect name.
Returns
Returns a table with the parameter names as the keys, and their values. If the specified effect name is not valid, an error is raised.
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 [-]
Clientlocal soundEchoParams = getSoundEffectParameters(sound, "echo")
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