getPitch.lua 510 B

12345678910111213141516171819202122
  1. return {
  2. tag = 'sourcePlayback',
  3. summary = 'Get the pitch of the Source.',
  4. description = 'Returns the pitch of the Source.',
  5. arguments = {},
  6. returns = {
  7. pitch = {
  8. type = 'number',
  9. description = 'The pitch.'
  10. }
  11. },
  12. variants = {
  13. {
  14. arguments = {},
  15. returns = { 'pitch' }
  16. }
  17. },
  18. notes = [[
  19. The default pitch is 1. Every doubling/halving of the pitch will raise/lower the pitch by one
  20. octave. Changing the pitch also changes the playback speed.
  21. ]]
  22. }