getVolume.lua 419 B

12345678910111213141516171819
  1. return {
  2. summary = 'Get the volume of the Source.',
  3. description = 'Returns the current volume factor for the Source.',
  4. arguments = {
  5. {
  6. name = 'units',
  7. type = 'VolumeUnit',
  8. default = [['linear']],
  9. description = 'The units to return (linear or db).'
  10. }
  11. },
  12. returns = {
  13. {
  14. name = 'volume',
  15. type = 'number',
  16. description = 'The volume of the Source.'
  17. }
  18. }
  19. }