Function Dump: Difference between revisions

Latest revision as of 23:46, 11 March 2012

This is the location for the listing of all of the Lua based functions, ones that are built into the system. These are not to be confused with user-defined functions, ones that are made in your own code. These are changed/added to by the ROBLOX staff for the base Lua code, and cannot be overwritten or edited.

These are broken up into 6 groups, where you can find more information about what you want to do on each page.

Core Functions: These are what help the Lua code run on Roblox. In here you can find listings for file manipulation, metatables, error handling and other basic system functions. If you aren't sure where the function is listed, look here first.
Coroutine Manipulation: Here is the listing for coroutine manipulation, which allows you to set several things working at once and for a limited time of running. Take a look here and here for more detailed explanations of coroutines.
String Manipulation: These functions let you do fancy things with words, such as changing the order of a string, comparing two strings and using the chat commands to do all kinds of fun stuff.
Table Manipulation: This section tells you how to play around with long lists of things and do fun stuff as well, such as reordering a table, sorting them, and searching for a specific item in a table.
Mathematical Functions: Just as the name implies, this is a listing of all the math functions in Roblox Lua. Here you can find a listing of everything from trigonometry to a value so huge it doesn't have a real number.
Roblox Specific Functions: These are functions that are only found in Roblox, and are used for a variety of things.

@@ Line 1: / Line 1: @@
-=Standard Lua Function libraries=
+This is the location for the listing of all of the Lua based functions, ones that are built into the system. These are not to be confused with user-defined functions, ones that are made in your own code. These are changed/added to by the ROBLOX staff for the base Lua code, and cannot be overwritten or edited.
-Directly off of the [http://www.lua.org/manual/5.1/manual.html#5 Lua Help Manual. ] These are all the functions included in the standard libraries that Roblox has built-in. Some functions have been removed, to preserve security.
+These are broken up into 6 groups, where you can find more information about what you want to do on each page.
+;[[Function Dump/Core Functions|Core Functions]]
+:These are what help the Lua code run on Roblox. In here you can find listings for file manipulation, metatables, error handling and other basic system functions. If you aren't sure where the function is listed, look here first.
+;[[Function Dump/Coroutine Manipulation|Coroutine Manipulation]]
+:Here is the listing for coroutine manipulation, which allows you to set several things working at once and for a limited time of running. Take a look [http://en.wikipedia.org/wiki/Coroutine here] and [http://www.lua.org/manual/5.1/manual.html#2.11 here] for more detailed explanations of coroutines.
+;[[Function Dump/String Manipulation|String Manipulation]]
+:These functions let you do fancy things with words, such as changing the order of a string, comparing two strings and using the chat commands to do all kinds of fun stuff.
-==Mathematical Functions==
+;[[Function Dump/Table Manipulation|Table Manipulation]]
+:This section tells you how to play around with long lists of things and do fun stuff as well, such as reordering a table, sorting them, and searching for a specific item in a table.
-This library is an interface to the standard C math library. It provides all its functions inside the table math.
+;[[Function Dump/Mathematical Functions|Mathematical Functions]]
+:Just as the name implies, this is a listing of all the math functions in Roblox Lua. Here you can find a listing of everything from trigonometry to a value so huge it doesn't have a real number.
+;[[Function Dump/Roblox Specific Functions|Roblox Specific Functions]]
-'''math.abs (x)'''
+:These are functions that are only found in Roblox, and are used for a variety of things.
-Returns the absolute value of x.
-'''math.acos (x)'''
-Returns the arc cosine of x (in radians).
-'''math.asin (x)'''
-Returns the arc sine of x (in radians).
-'''math.atan (x)'''
-Returns the arc tangent of x (in radians).
-'''math.atan2 (y, x)'''
-Returns the arc tangent of y/x (in radians), but uses the signs of both parameters to find the quadrant of the result. (It also handles correctly the case of x being zero.)
-'''math.ceil (x)'''
-Returns the smallest integer larger than or equal to x.
-'''math.cos (x)'''
-Returns the cosine of x (assumed to be in radians).
-'''math.cosh (x)'''
-Returns the hyperbolic cosine of x.
-''''math.deg (x)'''
-Returns the angle x (given in radians) in degrees.
-'''math.exp (x)'''
-Returns the the value ex.
-'''math.floor (x)'''
-Returns the largest integer smaller than or equal to x.
-'''math.fmod (x, y)'''
-Returns the remainder of the division of x by y.
-'''math.frexp (x)'''
-Returns m and e such that x = m2e, e is an integer and the absolute value of m is in the range [0.5, 1) (or zero when x is zero).
-'''math.huge'''
-The value HUGE_VAL, a value larger than or equal to any other numerical value.
-'''math.ldexp (m, e)'''
-Returns m2e (e should be an integer).
-'''math.log (x)'''
-Returns the natural logarithm of x.
-'''math.log10 (x)'''
-Returns the base-10 logarithm of x.
-'''math.max (x, ···)'''
-Returns the maximum value among its arguments.
-'''math.min (x, ···)'''
-Returns the minimum value among its arguments.
-'''math.modf (x)'''
-Returns two numbers, the integral part of x and the fractional part of x.
-'''math.pi'''
-The value of pi.
-'''math.pow (x, y)'''
-Returns xy. (You can also use the expression x^y to compute this value.)
-'''math.rad (x)'''
-Returns the angle x (given in degrees) in radians.
-'''math.random ([m [, n]])'''
-This function is an interface to the simple pseudo-random generator function rand provided by ANSI C. (No guarantees can be given for its statistical properties.)
-When called without arguments, returns a pseudo-random real number in the range [0,1). When called with a number m, math.random returns a pseudo-random integer in the range [1, m]. When called with two numbers m and n, math.random returns a pseudo-random integer in the range [m, n].
-'''math.randomseed (x)'''
-Sets x as the "seed" for the pseudo-random generator: equal seeds produce equal sequences of numbers.
-'''math.sin (x)'''
-Returns the sine of x (assumed to be in radians).
-'''math.sinh (x)'''
-Returns the hyperbolic sine of x.
-'''math.sqrt (x)'''
-Returns the square root of x. (You can also use the expression x^0.5 to compute this value.)
-'''math.tan (x)'''
-Returns the tangent of x (assumed to be in radians).
-'''math.tanh (x)'''
-Returns the hyperbolic tangent of x.
-----
 [[Category:Reference Pages]]

Function Dump: Difference between revisions

Latest revision as of 23:46, 11 March 2012

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Scripting Help

Legacy Client Help

Tools