setPose.lua 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. return {
  2. summary = 'Set the pose of the Collider.',
  3. description = 'Sets the position and orientation of the Collider.',
  4. arguments = {
  5. {
  6. name = 'x',
  7. type = 'number',
  8. description = 'The x position of the Collider, in meters.'
  9. },
  10. {
  11. name = 'y',
  12. type = 'number',
  13. description = 'The y position of the Collider, in meters.'
  14. },
  15. {
  16. name = 'z',
  17. type = 'number',
  18. description = 'The z position of the Collider, in meters.'
  19. },
  20. {
  21. name = 'angle',
  22. type = 'number',
  23. description = 'The number of radians the Collider is rotated around its axis of rotation.'
  24. },
  25. {
  26. name = 'ax',
  27. type = 'number',
  28. description = 'The x component of the axis of rotation.'
  29. },
  30. {
  31. name = 'ay',
  32. type = 'number',
  33. description = 'The y component of the axis of rotation.'
  34. },
  35. {
  36. name = 'az',
  37. type = 'number',
  38. description = 'The z component of the axis of rotation.'
  39. }
  40. },
  41. returns = {},
  42. related = {
  43. 'Collider:setPosition',
  44. 'Collider:setOrientation'
  45. }
  46. }