API Math

Math

Mathematical constants and numeric functions.

Script API Reference

Overview

Math is a static object of pure numeric operations. It has no constructor and holds no state. Trigonometric functions take and return angles in radians.

Caution

Math.random returns a pseudo-random value. Never use it for security tokens, session identifiers, or any cryptographic purpose.

Quick Reference

Member	Returns	Summary
Math.PI	number	Circle constant pi.
Math.E	number	Euler's number.
Math.Tau	number	Circle constant tau, equal to 2 * PI.
Math.DEG_PER_RAD	number	Degrees-per-radian conversion factor.
Math.abs(value)	number	Absolute value.
Math.max(...values)	number	Largest argument.
Math.min(...values)	number	Smallest argument.
Math.random()	number	Pseudo-random number.
Math.log(value)	number	Natural logarithm.
Math.pow(x, y)	number	x raised to the power y.
Math.exp(value)	number	e raised to the power value.
Math.cos(value)	number	Cosine of an angle in radians.
Math.sin(value)	number	Sine of an angle in radians.
Math.tan(value)	number	Tangent of an angle in radians.
Math.acos(value)	number	Arccosine in radians.
Math.asin(value)	number	Arcsine in radians.
Math.atan(value)	number	Arctangent in radians.
Math.ceil(value)	number	Rounds up to the nearest integer.
Math.floor(value)	number	Rounds down to the nearest integer.
Math.round(value)	number	Rounds to the nearest integer.

Constants

Constant	Type	Description
Math.PI	number	Circle constant pi.
Math.E	number	Euler's number.
Math.Tau	number	Circle constant tau, equal to 2 * PI.
Math.DEG_PER_RAD	number	Degrees per radian, used to convert radians to degrees.

Example

var halfTurn = Math.PI * Math.DEG_PER_RAD;
var fullTurn = Math.Tau * Math.DEG_PER_RAD;
return Math.round(halfTurn) + ":" + Math.round(fullTurn) + ":" + Math.round(Math.E); // 180:360:3

Methods

Math.abs(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the absolute value.

Example

return Math.abs(-4); // 4

Math.max(...values)

Parameters

Name	Type	Required	Description
values	number	Yes	One or more numbers, passed as variadic arguments.

Returns

number — the largest argument.

Example

return Math.max(2, 8, 5); // 8

Math.min(...values)

Parameters

Name	Type	Required	Description
values	number	Yes	One or more numbers, passed as variadic arguments.

Returns

number — the smallest argument.

Example

return Math.min(2, 8, 5); // 2

Math.random()

Parameters

None.

Returns

number — a pseudo-random number.

Example

var index = Math.floor(Math.random() * 10);
return index;

Math.log(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the natural logarithm of the value.

Example

return Math.round(Math.log(Math.E)); // 1

Math.pow(x, y)

Parameters

Name	Type	Required	Description
x	number	Yes	Base.
y	number	Yes	Exponent.

Returns

number — x raised to the power y.

Example

return Math.pow(2, 3); // 8

Math.exp(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Exponent applied to e.

Returns

number — e raised to the power value.

Example

return Math.round(Math.exp(Math.log(10))); // 10

Math.cos(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Angle in radians.

Returns

number — the cosine of the angle.

Example

return Math.cos(0); // 1

Math.sin(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Angle in radians.

Returns

number — the sine of the angle.

Example

return Math.sin(Math.PI / 2); // 1

Math.tan(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Angle in radians.

Returns

number — the tangent of the angle.

Example

return Math.tan(0); // 0

Math.acos(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the arccosine, in radians.

Example

return Math.acos(1); // 0

Math.asin(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the arcsine, in radians.

Example

return Math.round(Math.asin(1) * Math.DEG_PER_RAD); // 90

Math.atan(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the arctangent, in radians.

Example

return Math.atan(0); // 0

Math.ceil(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the value rounded up to the nearest integer.

Example

return Math.ceil(1.2); // 2

Math.floor(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the value rounded down to the nearest integer.

Example

return Math.floor(1.8); // 1

Math.round(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Input number.

Returns

number — the value rounded to the nearest integer.

Example

return Math.round(1.4); // 1