math

This library provides basic mathematical functions. It provides all its functions and constants inside the table math.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🎒 Examples

TODO Examples

🗼 Static Properties

Value	Name
3.141592653589793	math.pi
2^1024	math.huge

🗿 Static Functions

	Returns	Name	Description
	number	ceil	Return the integer no greater than the given value (even for negatives)
	number	tan	Return the tangent value for a given value in radians.
	number	min	Return the minimum value from a variable length list of arguments
	number	fmod	Returns the remainder of the division of base by modulator that rounds the quotient towards zero
	number	exp	Returns e (the base of natural logarithms) raised to the power exponent
	number	random	Generates pseudo-random numbers uniformly distributed
	number	rad	Convert from degrees to radians
	number	sin	Return the sine value for a given value in radians.
	number	cos	Return the cosine value for a given value in radians.
	number	asin	Return the inverse sine in radians of the given value.
		randomseed	Sets a seed for the pseudo-random generator: Equal seeds produce equal sequences of numbers
	number	floor	Return the integer no less than the given value (even for negatives)
	number	max	Return the maximum value from a variable length list of arguments
	number	atan	Return the inverse tangent in radians. We can do this by supplying y/x ourselves or we can pass y and x to math.atan to do this for us
	number	acos	Return the inverse cosine in radians of the given value.
	number	abs	Return the absolute, or non-negative value, of a given value
	number	log	Returns the inverse of this. math.exp(1) returns e
	number, number	modf	Return the integral and fractional parts of the given number
	number	deg	Convert from radians to degrees
	number	sqrt	Return the square root of a given number. Only non-negative arguments are allowed

---

ceil

Return the integer no greater than the given value (even for negatives)

local ret = math.ceil(number)

Parameters

Type	Parameter	Default	Description
number	number	Required parameter	The number to be rounded up.

Returns

Type	Description
number	No description provided

---

tan

Return the tangent value for a given value in radians.

local ret = math.tan(value)

Parameters

Type	Parameter	Default	Description
number	value	Required parameter	Angle in radians

Returns

Type	Description
number	No description provided

---

min

Return the minimum value from a variable length list of arguments

local ret = math.min(numbers...)

Parameters

Type	Parameter	Default	Description
varargs of number	numbers...	Required parameter	Numbers to get the smallest from.

Returns

Type	Description
number	No description provided

---

fmod

Returns the remainder of the division of base by modulator that rounds the quotient towards zero

local ret = math.fmod(base, modulator)

Parameters

Type	Parameter	Default	Description
number	base	Required parameter	The base value.
number	modulator	Required parameter	The modulator.

Returns

Type	Description
number	No description provided

---

exp

Returns e (the base of natural logarithms) raised to the power exponent

local ret = math.exp(exponent)

Parameters

Type	Parameter	Default	Description
number	exponent	Required parameter	The exponent for the function.

Returns

Type	Description
number	No description provided

---

random

Generates pseudo-random numbers uniformly distributed

local ret = math.random(m, n)

Parameters

Type	Parameter	Default	Description
number	m	Required parameter	If m is the only parameter: upper limit. If n is also provided: lower limit. If provided, this must be an integer.
number	n	Required parameter	Upper limit. If provided, this must be an integer.

Returns

Type	Description
number	No description provided

---

rad

Convert from degrees to radians

local ret = math.rad(degrees)

Parameters

Type	Parameter	Default	Description
number	degrees	Required parameter	The angle measured in degrees.

Returns

Type	Description
number	No description provided

---

sin

Return the sine value for a given value in radians.

local ret = math.sin(number)

Parameters

Type	Parameter	Default	Description
number	number	Required parameter	Angle in radians

Returns

Type	Description
number	No description provided

---

cos

Return the cosine value for a given value in radians.

local ret = math.cos(number)

Parameters

Type	Parameter	Default	Description
number	number	Required parameter	Angle in radians

Returns

Type	Description
number	No description provided

---

asin

Return the inverse sine in radians of the given value.

local ret = math.asin(normal)

Parameters

Type	Parameter	Default	Description
number	normal	Required parameter	Sine value in the range of -1 to 1.

Returns

Type	Description
number	No description provided

---

randomseed

Sets a seed for the pseudo-random generator: Equal seeds produce equal sequences of numbers

math.randomseed(seed)

Parameters

Type	Parameter	Default	Description
number	seed	Required parameter	The new seed

---

floor

Return the integer no less than the given value (even for negatives)

local ret = math.floor(number)

Parameters

Type	Parameter	Default	Description
number	number	Required parameter	The number to be rounded down.

Returns

Type	Description
number	No description provided

---

max

Return the maximum value from a variable length list of arguments

local ret = math.max(numbers...)

Parameters

Type	Parameter	Default	Description
varargs of number	numbers...	Required parameter	Numbers to get the largest from

Returns

Type	Description
number	No description provided

---

atan

Return the inverse tangent in radians. We can do this by supplying y/x ourselves or we can pass y and x to math.atan to do this for us

local ret = math.atan(normal)

Parameters

Type	Parameter	Default	Description
number	normal	Required parameter	Tangent value.

Returns

Type	Description
number	No description provided

---

acos

Return the inverse cosine in radians of the given value.

local ret = math.acos(cos)

Parameters

Type	Parameter	Default	Description
number	cos	Required parameter	Cosine value in range of -1 to 1.

Returns

Type	Description
number	No description provided

---

abs

Return the absolute, or non-negative value, of a given value

local ret = math.abs(x)

Parameters

Type	Parameter	Default	Description
number	x	Required parameter	The number to get the absolute value of.

Returns

Type	Description
number	No description provided

---

log

Returns the inverse of this. math.exp(1) returns e

local ret = math.log(x, base)

Parameters

Type	Parameter	Default	Description
number	x	Required parameter	The value to get the base from exponent from.
number	base	Required parameter	The logarithmic base.

Returns

Type	Description
number	No description provided

---

modf

Return the integral and fractional parts of the given number

local ret_1, ret_2 = math.modf(base)

Parameters

Type	Parameter	Default	Description
number	base	Required parameter	The base value.

Returns

Type	Description
number	No description provided
number	No description provided

---

deg

Convert from radians to degrees

local ret = math.deg(radians)

Parameters

Type	Parameter	Default	Description
number	radians	Required parameter	Value to be converted to degrees.

Returns

Type	Description
number	No description provided

---

sqrt

Return the square root of a given number. Only non-negative arguments are allowed

local ret = math.sqrt(value)

Parameters

Type	Parameter	Default	Description
number	value	Required parameter	Value to get the square root of.

Returns

Type	Description
number	No description provided