lovr-indeck/lovr-api/graphics/Model/getNodePosition.lua

return {
  summary = 'Get the position of a node.',
  description = 'Returns the position of a node.',
  arguments = {
    index = {
      type = 'number',
      description = 'The index of the node.'
    },
    name = {
      type = 'string',
      description = 'The name of the node.'
    },
    space = {
      type = 'OriginType',
      default = [['root']],
      description = [[
        Whether the position should be returned relative to the root node or the node's parent.
      ]]
    }
  },
  returns = {
    x = {
      type = 'number',
      description = 'The x coordinate.'
    },
    y = {
      type = 'number',
      description = 'The y coordinate.'
    },
    z = {
      type = 'number',
      description = 'The z coordinate.'
    }
  },
  variants = {
    {
      arguments = { 'index', 'space' },
      returns = { 'x', 'y', 'z' }
    },
    {
      arguments = { 'name', 'space' },
      returns = { 'x', 'y', 'z' }
    }
  },
  related = {
    'Model:getNodeOrientation',
    'Model:setNodeOrientation',
    'Model:getNodeScale',
    'Model:setNodeScale',
    'Model:getNodePose',
    'Model:setNodePose',
    'Model:getNodeTransform',
    'Model:setNodeTransform',
    'Model:animate'
  }
}