On this page
math
Types for this namespace are provided by the lua-types dependency and are not generated by @defold-typescript/types.
Documentation for the Lua math standard library.
From Lua 5.1 Reference Manual by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.
Copyright © 2006-2012 Lua.org, PUC-Rio.
Freely available under the terms of the Lua license.
Functions
math.abs(x: number): numbermath.acos(x: number): numbermath.asin(x: number): numbermath.atan(x: number): numbermath.atan2(y: number, x: number): numbermath.ceil(x: number): numbermath.cos(x: number): numbermath.cosh(x: number): numbermath.deg(x: number): numbermath.exp(x: number): numbermath.floor(x: number): numbermath.fmod(x: number, y: number): numbermath.frexp(x: number): LuaMultiReturn<[number, number]>math.ldexp(m: number, e: number): numbermath.log(x: number): numbermath.log10(x: number): numbermath.max(x: number, ...numbers: number[]): numbermath.min(x: number, ...numbers: number[]): numbermath.modf(x: number): LuaMultiReturn<[number, number]>math.pow(x: number, y: number): numbermath.rad(x: number): numbermath.random(m?: number, n?: number): numbermath.randomseed(x: number): numbermath.sin(x: number): numbermath.sinh(x: number): numbermath.sqrt(x: number): numbermath.tan(x: number): numbermath.tanh(x: number): number
math.abs(x: number): number
Returns the absolute value of x.
Parameters
x:number
math.acos(x: number): number
Returns the arc cosine of x (in radians).
Parameters
x:number
math.asin(x: number): number
Returns the arc sine of x (in radians).
Parameters
x:number
math.atan(x: number): number
Returns the arc tangent of x (in radians).
Parameters
x:number
math.atan2(y: number, x: number): number
Returns the arc tangent of y/x (in radians),
but uses the signs of both parameters to find the
quadrant of the result.
(It also handles correctly the case of x being zero.)
Parameters
y:numberx:number
math.ceil(x: number): number
Returns the smallest integer larger than or equal to x.
Parameters
x:number
math.cos(x: number): number
Returns the cosine of x (assumed to be in radians).
Parameters
x:number
math.cosh(x: number): number
Returns the hyperbolic cosine of x.
Parameters
x:number
math.deg(x: number): number
Returns the angle x (given in radians) in degrees.
Parameters
x:number
math.exp(x: number): number
Returns the value ex.
Parameters
x:number
math.floor(x: number): number
Returns the largest integer smaller than or equal to x.
Parameters
x:number
math.fmod(x: number, y: number): number
Returns the remainder of the division of x by y that rounds the quotient towards zero.
Parameters
x:numbery:number
math.frexp(x: number): LuaMultiReturn<[number, number]>
Returns m and e such that x = m2e, e is an integer and the absolute value of m is in the range [0.5, 1) (or zero when x is zero).
Parameters
x:number
math.ldexp(m: number, e: number): number
Returns m2e (e should be an integer).
Parameters
m:numbere:number
math.log(x: number): number
Returns the natural logarithm of x.
Parameters
x:number
math.log10(x: number): number
Returns the base-10 logarithm of x.
Parameters
x:number
math.max(x: number, ...numbers: number[]): number
Returns the maximum value among its arguments.
Parameters
x:number...
math.min(x: number, ...numbers: number[]): number
Returns the minimum value among its arguments.
Parameters
x:number...
math.modf(x: number): LuaMultiReturn<[number, number]>
Returns two numbers, the integral part of x and the fractional part of x.
Parameters
x:number
math.pow(x: number, y: number): number
Returns xy.
(You can also use the expression x^y to compute this value.)
Parameters
x:numbery:number
math.rad(x: number): number
Returns the angle x (given in degrees) in radians.
Parameters
x:number
math.random(m?: number, n?: number): number
This function is an interface to the simple pseudo-random generator function rand provided by ANSI C. (No guarantees can be given for its statistical properties.) When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].
Parameters
m?:numbern?:number
math.randomseed(x: number): number
Sets x as the "seed" for the pseudo-random generator: equal seeds produce equal sequences of numbers.
Parameters
x:number
math.sin(x: number): number
Returns the sine of x (assumed to be in radians).
Parameters
x:number
math.sinh(x: number): number
Returns the hyperbolic sine of x.
Parameters
x:number
math.sqrt(x: number): number
Returns the square root of x.
(You can also use the expression x^0.5 to compute this value.)
Parameters
x:number
math.tan(x: number): number
Returns the tangent of x (assumed to be in radians).
Parameters
x:number
math.tanh(x: number): number
Returns the hyperbolic tangent of x.
Parameters
x:number
Variables
math.huge: unknown
The value HUGE_VAL, a value larger than or equal to any other numerical value.
math.pi: unknown
The value of PI.