getWorldPoint.lua 972 B

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. return {
  2. summary = 'Convert a point from local space to world space.',
  3. description = 'Convert a point relative to the collider to a point in world coordinates.',
  4. arguments = {
  5. {
  6. name = 'x',
  7. type = 'number',
  8. description = 'The x position of the point.'
  9. },
  10. {
  11. name = 'y',
  12. type = 'number',
  13. description = 'The y position of the point.'
  14. },
  15. {
  16. name = 'z',
  17. type = 'number',
  18. description = 'The z position of the point.'
  19. }
  20. },
  21. returns = {
  22. {
  23. name = 'wx',
  24. type = 'number',
  25. description = 'The x coordinate of the world point.'
  26. },
  27. {
  28. name = 'wy',
  29. type = 'number',
  30. description = 'The y coordinate of the world point.'
  31. },
  32. {
  33. name = 'wz',
  34. type = 'number',
  35. description = 'The z coordinate of the world point.'
  36. }
  37. },
  38. related = {
  39. 'Collider:getLocalPoint',
  40. 'Collider:getLocalVector',
  41. 'Collider:getWorldVector'
  42. }
  43. }