setPosition.lua 911 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. return {
  2. summary = 'Set the Shape\'s position.',
  3. description = 'Set the position of the Shape relative to its Collider.',
  4. arguments = {
  5. x = {
  6. type = 'number',
  7. description = 'The x offset.'
  8. },
  9. y = {
  10. type = 'number',
  11. description = 'The y offset.'
  12. },
  13. z = {
  14. type = 'number',
  15. description = 'The z offset.'
  16. },
  17. position = {
  18. type = 'Vec3',
  19. description = 'The position.'
  20. }
  21. },
  22. returns = {},
  23. variants = {
  24. {
  25. description = 'Set the position of the Shape using numbers.',
  26. arguments = { 'x', 'y', 'z' },
  27. returns = {}
  28. },
  29. {
  30. description = 'Set the position of the Shape using a vector.',
  31. arguments = { 'position' },
  32. returns = {}
  33. }
  34. },
  35. notes = 'If the Shape isn\'t attached to a Collider, this will error.',
  36. related = {
  37. 'Shape:getOrientation',
  38. 'Shape:setOrientation'
  39. }
  40. }