getRadius.lua 649 B

12345678910111213141516171819
  1. return {
  2. summary = 'Get the radius of the Source.',
  3. description = [[
  4. Returns the radius of the Source, in meters.
  5. This does not control falloff or attenuation. It is only used for smoothing out occlusion. If
  6. a Source doesn't have a radius, then when it becomes occluded by a wall its volume will
  7. instantly drop. Giving the Source a radius that approximates its emitter's size will result in
  8. a smooth transition between audible and occluded, improving realism.
  9. ]],
  10. arguments = {},
  11. returns = {
  12. {
  13. name = 'radius',
  14. type = 'number',
  15. description = 'The radius of the Source, in meters.'
  16. }
  17. }
  18. }