getSound.lua 579 B

12345678910111213141516171819202122232425
  1. return {
  2. tag = 'sourceUtility',
  3. summary = 'Get the Sound object backing the Source.',
  4. description = [[
  5. Returns the `Sound` object backing the Source. Multiple Sources can share one Sound, allowing
  6. its data to only be loaded once. An easy way to do this sharing is by using `Source:clone`.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. sound = {
  11. type = 'Sound',
  12. description = 'The Sound object.'
  13. }
  14. },
  15. variants = {
  16. {
  17. arguments = {},
  18. returns = { 'sound' }
  19. }
  20. },
  21. related = {
  22. 'Source:clone',
  23. 'lovr.audio.newSource'
  24. }
  25. }