getNodePosition.lua 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. return {
  2. summary = 'Get the position of a node.',
  3. description = 'Returns the position of a node.',
  4. arguments = {
  5. node = {
  6. type = 'string | number',
  7. description = 'The name or index of a node.'
  8. },
  9. space = {
  10. type = 'OriginType',
  11. default = [['root']],
  12. description = [[
  13. Whether the position should be returned relative to the root node or the node's parent.
  14. ]]
  15. }
  16. },
  17. returns = {
  18. x = {
  19. type = 'number',
  20. description = 'The x coordinate.'
  21. },
  22. y = {
  23. type = 'number',
  24. description = 'The y coordinate.'
  25. },
  26. z = {
  27. type = 'number',
  28. description = 'The z coordinate.'
  29. }
  30. },
  31. variants = {
  32. {
  33. arguments = { 'node', 'space' },
  34. returns = { 'x', 'y', 'z' }
  35. }
  36. },
  37. related = {
  38. 'Model:getNodeOrientation',
  39. 'Model:setNodeOrientation',
  40. 'Model:getNodeScale',
  41. 'Model:setNodeScale',
  42. 'Model:getNodePose',
  43. 'Model:setNodePose',
  44. 'Model:getNodeTransform',
  45. 'Model:setNodeTransform',
  46. 'Model:animate'
  47. }
  48. }