getPosition.lua 595 B

12345678910111213141516171819202122232425262728293031
  1. return {
  2. summary = 'Get the Shape\'s position.',
  3. description = 'Get the position of the Shape relative to its Collider.',
  4. arguments = {},
  5. returns = {
  6. x = {
  7. type = 'number',
  8. description = 'The x offset.'
  9. },
  10. y = {
  11. type = 'number',
  12. description = 'The y offset.'
  13. },
  14. z = {
  15. type = 'number',
  16. description = 'The z offset.'
  17. }
  18. },
  19. variants = {
  20. {
  21. arguments = {},
  22. returns = { 'x', 'y', 'z' }
  23. }
  24. },
  25. related = {
  26. 'Shape:getOrientation',
  27. 'Shape:setOrientation',
  28. 'Shape:getPose',
  29. 'Shape:setPose'
  30. }
  31. }