setPosition.lua 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. return {
  2. summary = 'Set the position of the Collider.',
  3. description = 'Sets the position of the Collider.',
  4. arguments = {
  5. x = {
  6. type = 'number',
  7. description = 'The x position of the Collider, in meters.'
  8. },
  9. y = {
  10. type = 'number',
  11. description = 'The y position of the Collider, in meters.'
  12. },
  13. z = {
  14. type = 'number',
  15. description = 'The z position of the Collider, in meters.'
  16. },
  17. position = {
  18. type = 'Vec3',
  19. description = 'The position of the Collider, in meters.'
  20. }
  21. },
  22. returns = {},
  23. variants = {
  24. {
  25. description = 'Set the position of the Collider using numbers.',
  26. arguments = { 'x', 'y', 'z' },
  27. returns = {}
  28. },
  29. {
  30. description = 'Set the position of the Collider using a vector.',
  31. arguments = { 'position' },
  32. returns = {}
  33. }
  34. },
  35. related = {
  36. 'Collider:applyForce',
  37. 'Collider:getLinearVelocity',
  38. 'Collider:setLinearVelocity',
  39. 'Collider:getOrientation',
  40. 'Collider:setOrientation',
  41. 'Collider:getPose',
  42. 'Collider:setPose'
  43. }
  44. }