Scaleform Studio Lua API Reference: math namespace reference
Description
Math namespace
Related help topics 
Constants
Functions
x : | number |
Number to make absolute. |
number |
Returns the absolute value of x. |
x : | number |
A number representing a cosine between -1 and 1. |
number |
An angle in radians. |
x : | number |
A number representing a sine between -1 and 1. |
number |
An angle in radians. |
x : | number |
A number representing a tangent. |
number |
An angle in radians. |
y : | number |
The y coordinate of the point. |
x : | number |
The x coordinate of the point. |
number |
An angle in radians. |
x : | number |
A number. |
number |
An integer. |
x : | number |
An angle in radians. |
number |
The hyperbolic cosine of x. |
x : | number |
An angle in radians. |
number |
An angle in degrees. |
x : | number |
A number representing a power. |
number |
The value e^x. |
x : | number |
A number. |
number |
An integer. |
x : | number |
The dividend. |
y : | number |
The divisor. |
number |
The remainder. |
 |
Returns m and e such that x = m2^e, e is an integer and the absolute value of m is in the
range [0.5, 1) or 0 when x is 0.
|
x : | number |
A number representing x in x = m2^e |
number |
m in x = m2^e |
number |
e in x = m2^e |
m : | number |
The significand. |
e : | integer |
An integer exponent. |
number |
Returns the value of m2^e. |
x : | number |
A number. |
number |
The natural logarithm of x. |
x : | number |
A number. |
number |
The base-10 logarithm of x. |
x : | number+ |
A series of numbers. The + notation indicates that there may be one or more instances of the specified type. |
number |
The maximum number. |
x : | number+ |
A series of numbers. The + notation indicates that there may be one or more instances of the specified type. |
number |
The maximum number. |
x : | number |
A number. |
number |
The integral part of x. |
number |
The fractional part of x. |
x : | number |
A number. |
number |
The integral part of x. |
number |
The fractional part of x. |
x : | number |
A number. |
y : | number |
A number for the power. |
number |
The value of x raised to the power. |
x : | number |
An angle in degrees. |
number |
The angle in radians. |
| This function does not accept any parameters. |
number |
A uniform pseudo-random real number in the range [0,1). |
m : | number |
The maximum number. |
number |
A uniform pseudo-random integer in the range [1, m]. |
m : | number |
The minimum number. |
n : | number |
The maximum number. |
number |
A uniform pseudo-random integer in the range [m, m]. |
x : | number |
The seed. |
| This function does not return any values. |
x : | number |
An angle in radians. |
number |
The sine of x in radians. |
x : | number |
An angle in radians. |
number |
The hyperbolic sine of x. |
x : | number |
A non-negative number. |
number |
The square root of x. |
math.huge = 1.#INF : numberHUGE_VAL A numeric value.
math.pi = 3.1415926535898 : numberPI
math.abs (x) : numberReturns the absolute value of x.
x : numberNumber to make absolute.
numberReturns the absolute value of x.
math.acos (x) : numberReturns the arc cosine of x in radians.
x : numberA number representing a cosine between -1 and 1.
numberAn angle in radians.
math.asin (x) : numberReturns the arc sine of x in radians.
x : numberA number representing a sine between -1 and 1.
numberAn angle in radians.
math.atan (x) : numberReturns the arc tangent of x in radians.
x : numberA number representing a tangent.
numberAn angle in radians.
math.atan2 (y, x) : numberReturns the arc tangent of y/x in radians.
y : numberThe y coordinate of the point.
x : numberThe x coordinate of the point.
numberAn angle in radians.
math.ceil (x) : numberReturns the smallest integer larger than or equal to x.
x : numberA number.
numberAn integer.
math.cos (x) : numberReturns the cosine of x
x : numberAn angle in radians.
numberThe cosine of x.
math.cosh (x) : numberReturns the hyperbolic cosine of x.
x : numberAn angle in radians.
numberThe hyperbolic cosine of x.
math.deg (x) : numberConverts an angle in radians in degrees.
x : numberAn angle in radians.
numberAn angle in degrees.
math.exp (x) : numberReturns the value e^x.
x : numberA number representing a power.
numberThe value e^x.
math.floor (x) : numberReturns the largest integer smaller than or equal to x.
x : numberA number.
numberAn integer.
math.fmod (x, y) : numberReturns the remainder of the division of x by y that rounds the quotient towards 0.
x : numberThe dividend.
y : numberThe divisor.
numberThe remainder.
math.frexp (x) : number, numberReturns m and e such that x = m2^e, e is an integer and the absolute value of m is in the range [0.5, 1) or 0 when x is 0.
x : numberA number representing x in x = m2^e
numberm in x = m2^e
numbere in x = m2^e
math.ldexp (m, e) : numberReturns m2^e.
m : numberThe significand.
e : integerAn integer exponent.
numberReturns the value of m2^e.A strictly integral numeric value, with no decimal component.
math.log (x) : numberReturns the natural logarithm of x.
x : numberA number.
numberThe natural logarithm of x.
math.log10 (x) : numberReturns the base-10 logarithm of x.
x : numberA number.
numberThe base-10 logarithm of x.
math.max (x) : numberReturns the maximum value among its arguments.
x : number+A series of numbers.
numberThe maximum number.
math.min (x) : numberReturns the minimum value among its arguments.
x : number+A series of numbers.
numberThe maximum number.
math.mod (x) : number, numberReturns two numbers, the integral part of x and the fractional part of x.
x : numberA number.
numberThe integral part of x.
numberThe fractional part of x.
math.modf (x) : number, numberReturns two numbers, the integral part of x and the fractional part of x.
x : numberA number.
numberThe integral part of x.
numberThe fractional part of x.
math.pow (x, y) : numberReturns x^y.
x : numberA number.
y : numberA number for the power.
numberThe value of x raised to the power.
math.rad (x) : numberConverts an angle in degrees to radians.
x : numberAn angle in degrees.
numberThe angle in radians.
math.random () : numberReturns a uniform pseudo-random real number in the range [0,1).
numberA uniform pseudo-random real number in the range [0,1).
math.random (m) : numberReturns a uniform pseudo-random integer in the range [1, m].
m : numberThe maximum number.
numberA uniform pseudo-random integer in the range [1, m].
math.random (m, n) : numberReturns a uniform pseudo-random integer in the range [m, n].
m : numberThe minimum number.
n : numberThe maximum number.
numberA uniform pseudo-random integer in the range [m, m].
math.randomseed (x) Sets x as the seed for the pseudo-random generator.
x : numberThe seed.
math.sin (x) : numberReturns the sine of x.
x : numberAn angle in radians.
numberThe sine of x in radians.
math.sinh (x) : numberReturns the hyperbolic sine of x.
x : numberAn angle in radians.
numberThe hyperbolic sine of x.
math.sqrt (x) : numberReturns the square root of x.
x : numberA non-negative number.
numberThe square root of x.
math.tan (x) : numberReturns the tangent of x.
x : numberAngle in radians
numberThe tangent of x.
math.tanh (x) : numberReturns the hyperbolic tangent of x.
x : numberAngle in radians.
numberThe hyperbolic tangent of x.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.