setEffectEnabled.lua 662 B

1234567891011121314151617181920212223
  1. return {
  2. summary = 'Enable or disable an effect.',
  3. description = 'Enables or disables an effect on the Source.',
  4. arguments = {
  5. {
  6. name = 'effect',
  7. type = 'Effect',
  8. description = 'The effect.'
  9. },
  10. {
  11. name = 'enable',
  12. type = 'boolean',
  13. description = 'Whether the effect should be enabled.'
  14. }
  15. },
  16. returns = {},
  17. notes = [[
  18. The active spatializer will determine which effects are supported. If an unsupported effect is
  19. enabled on a Source, no error will be reported. Instead, it will be silently ignored.
  20. TODO: expose a table of supported effects for spatializers in docs or from Lua.
  21. ]]
  22. }