math
Summary
Properties
| pi : number |
| phi : number |
| e : number |
| inf : number |
| tau : number |
Methods
| abs (x: number) : number |
| acos (x: number) : number |
| asin (x: number) : number |
| atan (x: number) : number |
| atan2 (y: number, x: number) : number |
| ceil (x: number) : number |
| clamp (x: number, min: number, max: number) : number |
| cos (x: number) : number |
| cosh (x: number) : number |
| deg (x: number) : number |
| exp (x: number) : number |
| floor (x: number) : number |
| fmod (x: number, y: number) : number |
| frexp (x: number) : number, number |
| ldexp (x: number, e: number) : number |
| lerp (a: number, b: number, t: number) : number |
| log (x: number, base: number) : number |
| log10 (x: number) : number |
| max (x: number, ...: number) : number |
| min (x: number, ...: number) : number |
| modf (x: number) : number, number |
| noise (x: number, y: number, z: number) : number |
| pow (x: number, y: number) : number |
| rad (x: number) : number |
| round (x: number) : number |
| sign (x: number) : number |
| sin (x: number) : number |
| sinh (x: number) : number |
| sqrt (x: number) : number |
| tan (x: number) : number |
| tanh (x: number) : number |
Properties
pi
The mathematical constant of pi.
math.pi : number
phi
The mathematical constant of phi.
math.phi : number
e
The mathematical constant of e.
math.e : number
inf
A value larger than or equal to any other number (about 21024).
math.inf : number
tau
The mathematical constant of tau.
math.tau : number
Methods
abs
Returns the absolute value of x.
math.abs ( x: number ) : number
Parameters
| x : number |
Returns
| number |
acos
Returns the arccosine of x.
math.acos ( x: number ) : number
Parameters
| x : number |
Returns
| number |
asin
Returns the arcsine of x.
math.asin ( x: number ) : number
Parameters
| x : number |
Returns
| number |
atan
Returns the arctangent of x.
math.atan ( x: number ) : number
Parameters
| x : number |
Returns
| number |
atan2
Returns the arctangent of y/x in radians while using the signs of both arguments to determine the quadrant.
math.atan2 ( y: number, x: number ) : number
Parameters
| y : number |
| x : number |
Returns
| number |
ceil
Returns the smallest integer greater than or equal to x.
math.ceil ( x: number ) : number
Parameters
| x : number |
Returns
| number |
clamp
Clamps x to be between min and max, inclusive.
math.clamp (
x: number, min: number, max: number
) : number
Parameters
| x : number |
| min : number |
| max : number |
Returns
| number |
cos
Returns the cosine of x.
math.cos ( x: number ) : number
Parameters
| x : number |
Returns
| number |
cosh
Returns the hyperbolic cosine of x.
math.cosh ( x: number ) : number
Parameters
| x : number |
Returns
| number |
deg
Converts angle x from radians to degrees.
math.deg ( x: number ) : number
Parameters
| x : number |
Returns
| number |
exp
Returns e^x.
math.exp ( x: number ) : number
Parameters
| x : number |
Returns
| number |
floor
Returns the largest integer less than or equal to x.
math.floor ( x: number ) : number
Parameters
| x : number |
Returns
| number |
fmod
Returns the remainder of x divided by y.
math.fmod ( x: number, y: number ) : number
Parameters
| x : number |
| y : number |
Returns
| number |
frexp
Returns the mantissa and exponent of x. x = m*2^e.
math.frexp ( x: number ) : number, number
Parameters
| x : number |
Returns
| number |
| number |
ldexp
Returns x*2^e. e must be an integer.
math.ldexp ( x: number, e: number ) : number
Parameters
| x : number |
| e : number |
Returns
| number |
lerp
Returns the linear interpolation of a and b by t.
math.lerp (
a: number, b: number, t: number
) : number
Parameters
| a : number |
| b : number |
| t : number |
Returns
| number |
log
Returns the logarithm of x to the base base. If base is not provided, it defaults to e.
math.log ( x: number, base: number ) : number
Parameters
| x : number |
| base : number |
Returns
| number |
log10
Returns the base-10 logarithm of x.
math.log10 ( x: number ) : number
Parameters
| x : number |
Returns
| number |
max
Returns the maximum value among the provided arguments.
math.max ( x: number, ...: number ) : number
Parameters
| x : number |
| ... : number |
Returns
| number |
min
Returns the minimum value among the provided arguments.
math.min ( x: number, ...: number ) : number
Parameters
| x : number |
| ... : number |
Returns
| number |
modf
Returns the integer and fractional parts of x.
math.modf ( x: number ) : number, number
Parameters
| x : number |
Returns
| number |
| number |
noise
Returns a Perlin noise value for the given coordinates.
math.noise (
x: number, y: number, z: number
) : number
Parameters
| x : number |
| y : number |
| z : number |
Returns
| number |
pow
Returns x^y.
math.pow ( x: number, y: number ) : number
Parameters
| x : number |
| y : number |
Returns
| number |
rad
Converts angle x from degrees to radians.
math.rad ( x: number ) : number
Parameters
| x : number |
Returns
| number |
round
Returns x rounded to the nearest integer. If x is equidistant from two integers, it rounds away from zero.
math.round ( x: number ) : number
Parameters
| x : number |
Returns
| number |
sign
Returns the sign of x. Returns 1 if x is positive, -1 if x is negative, and 0 if x is zero.
math.sign ( x: number ) : number
Parameters
| x : number |
Returns
| number |
sin
Returns the sine of x.
math.sin ( x: number ) : number
Parameters
| x : number |
Returns
| number |
sinh
Returns the hyperbolic sine of x.
math.sinh ( x: number ) : number
Parameters
| x : number |
Returns
| number |
sqrt
Returns the square root of x.
math.sqrt ( x: number ) : number
Parameters
| x : number |
Returns
| number |
tan
Returns the tangent of x.
math.tan ( x: number ) : number
Parameters
| x : number |
Returns
| number |
tanh
Returns the hyperbolic tangent of x.
math.tanh ( x: number ) : number
Parameters
| x : number |
Returns
| number |