getWorldPoint.lua 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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. x = {
  6. type = 'number',
  7. description = 'The x position of the point.'
  8. },
  9. y = {
  10. type = 'number',
  11. description = 'The y position of the point.'
  12. },
  13. z = {
  14. type = 'number',
  15. description = 'The z position of the point.'
  16. },
  17. point = {
  18. type = 'Vec3',
  19. description = 'The local point.'
  20. }
  21. },
  22. returns = {
  23. wx = {
  24. type = 'number',
  25. description = 'The x coordinate of the world point.'
  26. },
  27. wy = {
  28. type = 'number',
  29. description = 'The y coordinate of the world point.'
  30. },
  31. wz = {
  32. type = 'number',
  33. description = 'The z coordinate of the world point.'
  34. }
  35. },
  36. variants = {
  37. {
  38. arguments = { 'x', 'y', 'z' },
  39. returns = { 'wx', 'wy', 'wz' }
  40. },
  41. {
  42. arguments = { 'point' },
  43. returns = { 'wx', 'wy', 'wz' }
  44. }
  45. },
  46. related = {
  47. 'Collider:getLocalPoint',
  48. 'Collider:getLocalVector',
  49. 'Collider:getWorldVector'
  50. }
  51. }