getFalloff.lua 772 B

12345678910111213141516171819202122232425262728293031
  1. return {
  2. summary = 'Get the falloff parameters for the Source.',
  3. description = [[
  4. Returns parameters that control how the volume of the Source falls of with distance.
  5. ]],
  6. arguments = {},
  7. returns = {
  8. {
  9. name = 'reference',
  10. type = 'number',
  11. description = 'The distance at which the volume will start to decrease.'
  12. },
  13. {
  14. name = 'max',
  15. type = 'number',
  16. description = 'The distance at which the Source will be its quietest.'
  17. },
  18. {
  19. name = 'rolloff',
  20. type = 'number',
  21. description = [[
  22. How quickly the sound falls off between the reference and max distances (1.0 is the
  23. default).
  24. ]]
  25. }
  26. },
  27. related = {
  28. 'Source:getVolumeLimits',
  29. 'Source:setVolumeLimits'
  30. }
  31. }