getOrientation.lua 706 B

12345678910111213141516171819202122232425262728293031
  1. return {
  2. summary = 'Get the Shape\'s orientation.',
  3. description = 'Get the orientation of the Shape relative to its Collider.',
  4. arguments = {},
  5. returns = {
  6. {
  7. name = 'angle',
  8. type = 'number',
  9. description = 'The number of radians the Shape is rotated.'
  10. },
  11. {
  12. name = 'ax',
  13. type = 'number',
  14. description = 'The x component of the rotation axis.'
  15. },
  16. {
  17. name = 'ay',
  18. type = 'number',
  19. description = 'The y component of the rotation axis.'
  20. },
  21. {
  22. name = 'az',
  23. type = 'number',
  24. description = 'The z component of the rotation axis.'
  25. }
  26. },
  27. related = {
  28. 'Shape:getPosition',
  29. 'Shape:setPosition'
  30. }
  31. }