math

顯示已棄用項目

This library is an interface to the standard C math library, providing all of its functions inside the math table.

概要

函式

abs(x : number):number
Returns the absolute value of x.
acos(x : number):number
Returns the arc cosine of x.
asin(x : number):number
Returns the arc sine of x.
atan(x : number):number
Returns the arc tangent of x in radians.
atan2(y : number,x : number):number
Returns the arc tangent of y/x (in radians) while using the signs of both parameters to find the quadrant of the result.
ceil(x : number):number
Returns the smallest integer larger than or equal to x.
clamp(x : number,min : number,max : number):number
Returns a number between min and max, inclusive.
cos(x : number):number
Returns the cosine of x, assumed to be in radians.
cosh(x : number):number
Returns the hyperbolic cosine of x.
deg(x : number):number
Returns the angle x (given in radians) in degrees.
exp(x : number):number
Returns the value e^x.
floor(x : number):number
Returns the largest integer smaller than or equal to x.
fmod(x : number,y : number):number
Returns the remainder of the division of x by y that rounds the quotient towards zero.
frexp(x : number):number,number
Returns m and e such that x = m*2^e.
ldexp(x : number,e : number):number
Returns x*2^e (e should be an integer).
lerp(a : number,b : number,t : number):number
Returns the linear interpolation between a and b.
log(x : number,base : number):number
Returns the logarithm of x using the given base.
log10(x : number):number
Returns the base-10 logarithm of x.
map(x : number,inmin : number,inmax : number,outmin : number,outmax : number):number
Returns the value of x mapped from one range to another.
max(x : number,... : number):number
Returns the maximum value among the numbers passed to the function.
min(x : number,... : number):number
Returns the minimum value among the numbers passed to the function.
modf(x : number):number,number
Returns two numbers: the integral part of x and the fractional part of x.
noise(x : number,y : number,z : number):number
Returns a Perlin noise value.
pow(x : number,y : number):number
Returns x^y.
rad(x : number):number
Returns the angle x (given in degrees) in radians.
random(m : number,n : number):number
Returns a random number within the range provided.
randomseed(x : number):void
Sets x as the seed for the pseudo-random generator.
round(x : number):number
Returns the integer with the smallest difference between it and the given number.
sign(x : number):number
Returns -1 if x is less than 0, 0 if x equals 0, or 1 if x is greater than 0.
sin(x : number):number
Returns the sine of x, assumed to be in radians.
sinh(x : number):number
Returns the hyperbolic sine of x.
sqrt(x : number):number
Returns the square root of x.
tan(x : number):number
Returns the tangent of x, assumed to be in radians.
tanh(x : number):number
Returns the hyperbolic tangent of x.

屬性

huge:number
Returns a value larger than or equal to any other numerical value (about 2¹⁰²⁴).
pi:number
The value of pi.

函式

abs

number

Returns the absolute value of x.

參數

x: number

number

acos

number

Returns the arc cosine of x.

參數

x: number

number

asin

number

Returns the arc sine of x.

參數

x: number

number

atan

number

Returns the arc tangent of x in radians.

參數

x: number

number

atan2

number

Returns the arc tangent of y/x (in radians) while using the signs of both parameters to find the quadrant of the result. It also handles correctly the case of x being zero.

參數

y: number

x: number

number

ceil

number

Returns the smallest integer larger than or equal to x.

參數

x: number

number

clamp

number

Returns a number between min and max, inclusive.

參數

x: number

min: number

max: number

number

cos

number

Returns the cosine of x, assumed to be in radians.

參數

x: number

number

cosh

number

Returns the hyperbolic cosine of x.

參數

x: number

number

deg

number

Returns the angle x (given in radians) in degrees.

參數

x: number

number

exp

number

Returns the value e^x.

參數

x: number

number

floor

number

Returns the largest integer smaller than or equal to x.

參數

x: number

number

fmod

number

Returns the remainder of the division of x by y that rounds the quotient towards zero.

參數

x: number

y: number

number

frexp

number

Returns m and e such that x = m*2^e. e is an integer and the absolute value of m is in the range of 0.5 to 1 (inclusive of 0.5 but exclusive of 1), or zero when x is zero.

參數

x: number

number

ldexp

number

Returns x*2^e (e should be an integer).

參數

x: number

e: number

number

lerp

number

Returns the linear interpolation between a and b based on the factor t.

This function uses the formula a+(b-a)*t. t is typically between 0 and 1 but values outside this range are acceptable.

參數

a: number

The starting value.

b: number

The ending value.

t: number

The interpolation factor, typically between 0 and 1.

number

The interpolated value between a and b.

log

number

Returns the logarithm of x using the given base, or the mathematical constant e if no base is provided (natural logarithm).

參數

x: number

base: number

The base of the logarithm, the constant e by default.

預設值：2.7182818

number

log10

number

Returns the base-10 logarithm of x.

參數

x: number

number

map

number

Returns a value that represents x mapped linearly from the input range (inmin to inmax) to the output range (outmin to outmax). This is achieved by determining the relative position of x within the input range and applying that ratio to the output range.

參數

x: number

The number to be mapped.

inmin: number

The lower bound of the input range.

inmax: number

The upper bound of the input range.

outmin: number

The lower bound of the output range.

outmax: number

The upper bound of the output range.

number

The value of x mapped to the output range.

max

number

Returns the maximum value among the numbers passed to the function.

參數

x: number

...: number

number

min

number

Returns the minimum value among the numbers passed to the function.

參數

x: number

...: number

number

modf

number

Returns two numbers: the integral part of x and the fractional part of x.

參數

x: number

number

noise

number

Returns a Perlin noise value. The returned value is most often between the range of -1 to 1 (inclusive) but sometimes may be outside that range; if the interval is critical to you, use math.clamp(noise, -1, 1) on the output.

If you leave arguments out, they will be interpreted as zero, so math.noise(1.158) is equivalent to math.noise(1.158, 0, 0) and math.noise(1.158, 5.723) is equivalent to math.noise(1.158, 5.723, 0).

Note that this function uses a Perlin noise algorithm to assign fixed values to coordinates. For example, math.noise(1.158, 5.723) will always return 0.48397532105446 and math.noise(1.158, 6) will always return 0.15315161645412.

If x, y, and z are all integers, the return value will be 0. For fractional values of x, y, and z, the return value will gradually fluctuate between -0.5 and 0.5. For coordinates that are close to each other, the return values will also be close to each other.

參數

x: number

y: number

預設值：0

z: number

預設值：0

number

pow

number

Returns x^y (you can also use the expression x^y to compute this value).

參數

x: number

y: number

number

rad

number

Returns the angle x (given in degrees) in radians.

參數

x: number

number

random

number

When called without arguments, returns a uniform pseudo-random real number in the range of 0 to 1 (inclusive of 0 but exclusive of 1).

When called with an integer number m, returns a uniform pseudo-random integer in the range of 1 to m, inclusive.

When called with two integer numbers m and n, returns a uniform pseudo-random integer in the range of m to n, inclusive.

Internally, this uses a 32-bit PCG (Permuted Congruential Generator) which achieves excellent statistical performance and makes its output hard to predict.

參數

m: number

預設值：0

n: number

預設值：1

number

randomseed

void

Sets x as the seed for the pseudo-random generator: equal seeds produce equal sequences of numbers.

參數

x: number

void

round

number

Returns the integer with the smallest difference between it and the given number. For example, the value 5.8 returns 6.

For values like 0.5 that are equidistant to two integers, the value with the greater difference between it and zero is chosen. In other words, the function "rounds away from zero" such that 0.5 rounds to 1 and -0.5 rounds to -1.