lovr-indeck/lovr-api/math/Quat/normalize.lua

return {
  summary = 'Normalize the length of the quaternion to 1.',
  description = 'Adjusts the values in the quaternion so that its length becomes 1.',
  arguments = {},
  returns = {
    self = {
      type = 'Quat',
      description = 'The normalized quaternion.'
    }
  },
  variants = {
    {
      arguments = {},
      returns = { 'self' }
    }
  },
  notes = [[
    A common source of bugs with quaternions is to forget to normalize them after performing a
    series of operations on them.  Try normalizing a quaternion if some of the calculations aren't
    working quite right!
  ]],
  related = {
    'Quat:length'
  }
}