Extend math

Extensions to the math module.

Functions

deg2rad (deg) Converts degrees to radians.
rad2deg (rad) Converts radians to degrees.
clamp (num, low, high) Clamps a number between a minimum and maximum.
randomRange (low, high) Returns a random (rational) number between the given minimum and maximum.
sign (x) Returns the sign of the number.
round (i[, decimals=0]) Rounds a number to the nearest given amount of decimals.
approach (cur, target, inc) Approach target number from current number with a given increment.
lerp (a, b, frac) Lerp between two numbers with a given fraction.
smooth (a, b, frac) Lerp using cosine interprolation between two numbers with a given fraction.


Functions

deg2rad (deg)
Converts degrees to radians.

Parameters:

  • deg number angle in degrees

Returns:

    number angle in radians
rad2deg (rad)
Converts radians to degrees.

Parameters:

  • rad number angle in radians

Returns:

    number angle in degrees
clamp (num, low, high)
Clamps a number between a minimum and maximum.

Parameters:

  • num number input number
  • low number minimum
  • high number maximum

Returns:

    number clamped number
randomRange (low, high)
Returns a random (rational) number between the given minimum and maximum.

Parameters:

  • low number minimum
  • high number maximum

Returns:

    number random number
sign (x)
Returns the sign of the number. Meaning it returns -1 if the number < 0, otherwise returns 1.

Parameters:

  • x number input number

Returns:

    number sign number (-1 or 1)
round (i[, decimals=0])
Rounds a number to the nearest given amount of decimals.

Parameters:

  • i number input number
  • decimals number amount of decimals (default 0)

Returns:

    number rounded number
approach (cur, target, inc)
Approach target number from current number with a given increment.

Parameters:

  • cur number input number
  • target number target number
  • inc number increment

Returns:

    number result
lerp (a, b, frac)
Lerp between two numbers with a given fraction.

Parameters:

  • a number first number
  • b number second number
  • frac number fraction

Returns:

    number result
smooth (a, b, frac)
Lerp using cosine interprolation between two numbers with a given fraction.

Parameters:

  • a number first number
  • b number second number
  • frac number fraction

Returns:

    number result
generated by LDoc 1.4.3 Last updated 2015-04-20 03:01:38