setOrientation.lua 1.1 KB

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