setOrientation.lua 780 B

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