M MY Multiplayer: Wiki
Side
Kind

getSoundEffectParameters

Client

Returns the current parameters of an audio effect that is on, on a sound or a player's voice.

table|false getSoundEffectParameters(sound|player target, string effect)

Parameters

NameTypeDescription
targetsound|playerA sound, a dui, or a player to change their voice in voice chat.
effectstringThe effect's name: chorus, compressor, distortion, echo, flanger, gargle, i3dl2reverb, parameq, reverb or radio.

Returns

A table of each parameter's name and value (a number, or a boolean for panDelay), or false if the target was not found.

Example

setSoundEffectEnabled(music, "reverb", true)
for name, value in pairs(getSoundEffectParameters(music, "reverb")) do
    outputDebugString(name .. " = " .. tostring(value))
end
NoteRaises an error if the effect is not on.

See also