getLocalPoint.lua 1.0 KB

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