Ir para o conteúdo principal
Version: latest - a1.65.x ⚖️

# 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!

TODO Examples

## 🗼 Static Properties​

ValueName
3.141592653589793math.pi
2^1024math.huge

## 🗿 Static Functions​

ReturnsNameDescription
numberceilReturn the integer no greater than the given value (even for negatives)
numbertanReturn the tangent value for a given value in radians.
numberminReturn the minimum value from a variable length list of arguments
numberfmodReturns the remainder of the division of base by modulator that rounds the quotient towards zero
numberexpReturns e (the base of natural logarithms) raised to the power exponent
numberrandomGenerates pseudo-random numbers uniformly distributed
numberradConvert from degrees to radians
numbersinReturn the sine value for a given value in radians.
numbercosReturn the cosine value for a given value in radians.
numberasinReturn the inverse sine in radians of the given value.
randomseedSets a seed for the pseudo-random generator: Equal seeds produce equal sequences of numbers
numberfloorReturn the integer no less than the given value (even for negatives)
numbermaxReturn the maximum value from a variable length list of arguments
numberatanReturn 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
numberacosReturn the inverse cosine in radians of the given value.
numberabsReturn the absolute, or non-negative value, of a given value
numberlogReturns the inverse of this. math.exp(1) returns e
number, numbermodfReturn the integral and fractional parts of the given number
numberdegConvert from radians to degrees
numbersqrtReturn 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)

— Returns number.

local ret = math.ceil(number)
TypeParameterDefaultDescription
numbernumber Required parameter The number to be rounded up.

### tan

Return the tangent value for a given value in radians.

— Returns number.

local ret = math.tan(value)
TypeParameterDefaultDescription
numbervalue Required parameter Angle in radians

### min

Return the minimum value from a variable length list of arguments

— Returns number.

local ret = math.min(numbers...)
TypeParameterDefaultDescription
numbers... Required parameter Numbers to get the smallest from.

### fmod

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

— Returns number.

local ret = math.fmod(base, modulator)
TypeParameterDefaultDescription
numberbase Required parameter The base value.
numbermodulator Required parameter The modulator.

### exp

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

— Returns number.

local ret = math.exp(exponent)
TypeParameterDefaultDescription
numberexponent Required parameter The exponent for the function.

### random

Generates pseudo-random numbers uniformly distributed

— Returns number.

local ret = math.random(m, n)
TypeParameterDefaultDescription
numberm Required parameter If m is the only parameter: upper limit. If n is also provided: lower limit. If provided, this must be an integer.
numbern Required parameter Upper limit. If provided, this must be an integer.

### rad

Convert from degrees to radians

— Returns number.

local ret = math.rad(degrees)
TypeParameterDefaultDescription
numberdegrees Required parameter The angle measured in degrees.

### sin

Return the sine value for a given value in radians.

— Returns number.

local ret = math.sin(number)
TypeParameterDefaultDescription
numbernumber Required parameter Angle in radians

### cos

Return the cosine value for a given value in radians.

— Returns number.

local ret = math.cos(number)
TypeParameterDefaultDescription
numbernumber Required parameter Angle in radians

### asin

Return the inverse sine in radians of the given value.

— Returns number.

local ret = math.asin(normal)
TypeParameterDefaultDescription
numbernormal Required parameter Sine value in the range of -1 to 1.

### randomseed

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

math.randomseed(seed)
TypeParameterDefaultDescription
numberseed Required parameter The new seed

### floor

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

— Returns number.

local ret = math.floor(number)
TypeParameterDefaultDescription
numbernumber Required parameter The number to be rounded down.

### max

Return the maximum value from a variable length list of arguments

— Returns number.

local ret = math.max(numbers...)
TypeParameterDefaultDescription
numbers... Required parameter Numbers to get the largest from

### 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

— Returns number.

local ret = math.atan(normal)
TypeParameterDefaultDescription
numbernormal Required parameter Tangent value.

### acos

Return the inverse cosine in radians of the given value.

— Returns number.

local ret = math.acos(cos)
TypeParameterDefaultDescription
numbercos Required parameter Cosine value in range of -1 to 1.

### abs

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

— Returns number.

local ret = math.abs(x)
TypeParameterDefaultDescription
numberx Required parameter The number to get the absolute value of.

### log

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

— Returns number.

local ret = math.log(x, base)
TypeParameterDefaultDescription
numberx Required parameter The value to get the base from exponent from.
numberbase Required parameter The logarithmic base.

### modf

Return the integral and fractional parts of the given number

— Returns number, number (, ).

local ret_01, ret_02 = math.modf(base)
TypeParameterDefaultDescription
numberbase Required parameter The base value.

### deg

Convert from radians to degrees

— Returns number.

local ret = math.deg(radians)
TypeParameterDefaultDescription
numberradians Required parameter Value to be converted to degrees.

### sqrt

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

— Returns number.

local ret = math.sqrt(value)
TypeParameterDefaultDescription
numbervalue Required parameter Value to get the square root of.