setPosition.lua 581 B

123456789101112131415161718192021222324252627
  1. return {
  2. summary = 'Set the Shape\'s position.',
  3. description = 'Set the position of the Shape relative to its Collider.',
  4. arguments = {
  5. {
  6. name = 'x',
  7. type = 'number',
  8. description = 'The x offset.'
  9. },
  10. {
  11. name = 'y',
  12. type = 'number',
  13. description = 'The y offset.'
  14. },
  15. {
  16. name = 'z',
  17. type = 'number',
  18. description = 'The z offset.'
  19. }
  20. },
  21. notes = 'If the Shape isn\'t attached to a Collider, this will error.',
  22. returns = {},
  23. related = {
  24. 'Shape:getOrientation',
  25. 'Shape:setOrientation'
  26. }
  27. }