GetSoundEffects

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Returns the states of all effects of a sound.

Syntax

table getSoundEffects ( element sound )

OOP Syntax Help! I don't understand this!

Method: sound:getEffects(...)


Required Arguments

Returns

Returns a table with the effect names as the keys, and their states as the values if successful. Otherwise, it returns false.

Sound effect names:

  • gargle
  • compressor
  • echo
  • i3dl2reverb
  • distortion
  • chorus
  • parameq
  • reverb
  • flanger

Example

function switchEffects(sound)
	for _,v in ipairs(getSoundEffects(sound)) do -- Go through the whole list of sound effects for the sound
		if v == "gargle" then -- If the sound effect is 'gargle', proceed
			setSoundEffectEnabled(sound, "gargle", false) -- Disable the 'gargle' -effect
		end
	end
end

See Also