getVolumeLimits.lua 595 B

123456789101112131415161718192021
  1. return {
  2. summary = 'Get the volume limits of the Source.',
  3. description = [[
  4. Returns the minimum and maximum volume of the Source. These limits have priority over the
  5. parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a
  6. Source can always be heard even if it's far away.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. {
  11. name = 'min',
  12. type = 'number',
  13. description = 'The minimum volume of the Source.'
  14. },
  15. {
  16. name = 'max',
  17. type = 'number',
  18. description = 'The maximum volume of the Source.'
  19. }
  20. }
  21. }