lovr-indeck/lovr-api/math/Vec3/dot.lua

return {
  summary = 'Get the dot product with another vector.',
  description = 'Returns the dot product between this vector and another one.',
  arguments = {
    u = {
      type = 'Vec3',
      description = 'The vector to compute the dot product with.'
    },
    x = {
      type = 'number',
      description = 'A value of x component to compute the dot product with.'
    },
    y = {
      type = 'number',
      description = 'A value of y component to compute the dot product with.'
    },
    z = {
      type = 'number',
      description = 'A value of z component to compute the dot product with.'
    }
  },
  returns = {
    dot = {
      type = 'number',
      description = 'The dot product between `v` and `u`.'
    }
  },
  variants = {
    {
      arguments = { 'u' },
      returns = { 'dot' }
    },
    {
      arguments = { 'x', 'y', 'z' },
      returns = { 'dot' }
    }
  },
  notes = [[
    This is computed as:

        dot = v.x * u.x + v.y * u.y + v.z * u.z

    The vectors are not normalized before computing the dot product.
  ]],
  related = {
    'Vec3:cross'
  }
}