|
|
| (38 intermediate revisions by 4 users not shown) |
| 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. This is a pre-defined list, for more information on functions, [[Functions|see the main article.]]
| | These are broken up into 6 groups, where you can find more information about what you want to do on each page. |
|
| |
|
| ==Basic Functions==
| | ;[[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. |
| The basic library provides some core functions to Lua. If you do not include this library in your application, you should check carefully whether you need to provide implementations for some of its facilities.
| | ;[[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]] |
| '''assert (v [, message])'''
| | :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. |
| | | ;[[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. |
| Issues an error when the value of its argument v is false (i.e., nil or false); otherwise, returns all its arguments. message is an error message; when absent, it defaults to "assertion failed!"
| | ;[[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. |
| {{Example|1=<i></i> <!--Ignore this; it acts oddly if it isn't here-->
| | ;[[Function Dump/Roblox Specific Functions|Roblox Specific Functions]] |
| assert (false, "This is an error message")
| | :These are functions that are only found in Roblox, and are used for a variety of things. |
| Will result in:
| |
| Tue Oct 07 10:15:37 2008 - <font color="red">Cmd:1: This is an error message</font color>
| |
| Tue Oct 07 10:15:37 2008 - <font color="blue">Cmd, line 1</font color>
| |
| Tue Oct 07 10:15:37 2008 - <font color="blue">stack end</font color>
| |
| | |
| assert (false)
| |
| Will result in:
| |
| Tue Oct 07 10:14:18 2008 - <font color="red">Cmd:1: assertion failed!</font color>
| |
| Tue Oct 07 10:14:18 2008 - <font color="blue">Cmd, line 1</font color>
| |
| Tue Oct 07 10:14:18 2008 - <font color="blue">stack end</font color>
| |
| | |
| assert (true)
| |
| Won't display anything at all.
| |
| }}
| |
| | |
| '''collectgarbage (opt [, arg])'''
| |
| | |
| | |
| This function is a generic interface to the garbage collector. It performs different functions according to its first argument, opt:
| |
| | |
| * "stop": stops the garbage collector.
| |
| * "restart": restarts the garbage collector.
| |
| * "collect": performs a full garbage-collection cycle.
| |
| * "count": returns the total memory in use by Lua (in Kbytes).
| |
| * "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.
| |
| * "setpause": sets arg/100 as the new value for the pause of the collector (see §2.10).
| |
| * "setstepmul": sets arg/100 as the new value for the step multiplier of the collector (see §2.10).
| |
| | |
| | |
| '''dofile (filename)'''
| |
| | |
| | |
| Opens the named file and executes its contents as a Lua chunk. When called without arguments, dofile executes the contents of the standard input (stdin). Returns all values returned by the chunk. In case of errors, dofile propagates the error to its caller (that is, dofile does not run in protected mode). <font color="red">The current security context cannot dofile.</font>
| |
| | |
| | |
| '''error (message [, level])'''
| |
| | |
| | |
| Terminates the last protected function called and returns message as the error message. Function error never returns.
| |
| | |
| Usually, error adds some information about the error position at the beginning of the message. The level argument specifies how to get the error position. With level 1 (the default), the error position is where the error function was called. Level 2 points the error to where the function that called error was called; and so on. Passing a level 0 avoids the addition of error position information to the message.
| |
| | |
| {{Example|1=<i></i>
| |
| error ("this is an error message")
| |
| Will result in:
| |
| Tue Oct 07 08:18:36 2008 - <font color="red">Cmd:1: this is an error message</font color>
| |
| Tue Oct 07 08:18:36 2008 - <font color="blue">Cmd, line 1</font color>
| |
| Tue Oct 07 08:18:36 2008 - <font color="blue">stack end</font color>
| |
| }}
| |
| | |
| '''_G'''
| |
| | |
| | |
| A global variable (not a function) that holds the global environment (that is, _G._G = _G). Lua itself does not use this variable; changing its value does not affect any environment, nor vice-versa. (Use setfenv to change environments.)
| |
| | |
| {{Example|1=<i></i>
| |
| function tellme()
| |
| for n,v in pairs(_G) do
| |
| print (n,v)
| |
| end
| |
| end<br>
| |
| tellme()<br>
| |
| Will result in a long list of global variables [http://www.wellho.net/resources/ex.php4?item=u112/globals].
| |
| }}
| |
| | |
| '''getfenv ([f])'''
| |
| | |
| | |
| Returns the current environment in use by the function. f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling getfenv. If the given function is not a Lua function, or if f is 0, getfenv returns the global environment. The default for f is 1.
| |
| | |
| {{Example|1=<i></i>
| |
| function myfunction()
| |
| print (getfenv(myfunction() ))
| |
| end<br>
| |
| myfunction()<br>
| |
| Will result in:
| |
| Mon Oct 13 14:33:37 2008 - <font color="blue">Workspace.Script, line 2 - global myfunction</font>
| |
| }}
| |
| | |
| '''getmetatable (object)'''
| |
| | |
| | |
| If object does not have a metatable, returns nil. Otherwise, if the object's metatable has a "__metatable" field, returns the associated value. Otherwise, returns the metatable of the given object.
| |
| | |
| | |
| '''ipairs (t)'''
| |
| | |
| | |
| Returns three values: an iterator function, the table t, and 0, so that the construction
| |
| | |
| for i,v in ipairs(t) do body end
| |
| | |
| will iterate over the pairs (1,t[1]), (2,t[2]), ···, up to the first integer key absent from the table.
| |
| | |
| {{Example|
| |
| <pre>
| |
| days = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"}
| |
| revdays = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"}
| |
| for i,v in ipairs(days) do
| |
| revdays[v] = i
| |
| print(revdays[v])
| |
| end
| |
| | |
| Will result in:
| |
| 1
| |
| 2
| |
| 3
| |
| 4
| |
| 5
| |
| 6
| |
| 7
| |
| </pre>
| |
| }}
| |
| | |
| '''load (func [, chunkname])'''
| |
| | |
| | |
| Loads a chunk using function func to get its pieces. Each call to func must return a string that concatenates with previous results. A return of nil (or no value) signals the end of the chunk.
| |
| | |
| If there are no errors, returns the compiled chunk as a function; otherwise, returns nil plus the error message. The environment of the returned function is the global environment.
| |
| | |
| chunkname is used as the chunk name for error messages and debug information.
| |
| | |
| | |
| '''loadfile ([filename])'''
| |
| | |
| | |
| Similar to load, but gets the chunk from file filename or from the standard input, if no file name is given. <font color="red">The current security context cannot loadfile.</font>
| |
| | |
| | |
| '''loadstring (string [, chunkname])'''
| |
| | |
| | |
| Similar to load, but gets the chunk from the given string.
| |
| | |
| To load and run a given string, use the idiom
| |
| | |
| assert(loadstring(s))()
| |
| | |
| | |
| '''next (table [, index])'''
| |
| | |
| | |
| Allows a program to traverse all fields of a table. Its first argument is a table and its second argument is an index in this table. next returns the next index of the table and its associated value. When called with nil as its second argument, next returns an initial index and its associated value. When called with the last index, or with nil in an empty table, next returns nil. If the second argument is absent, then it is interpreted as nil. In particular, you can use next(t) to check whether a table is empty.
| |
| | |
| The order in which the indices are enumerated is not specified, even for numeric indices. (To traverse a table in numeric order, use a numerical for or the ipairs function.)
| |
| | |
| The behavior of next is undefined if, during the traversal, you assign any value to a non-existent field in the table. You may however modify existing fields. In particular, you may clear existing fields.
| |
| | |
| {{Example|
| |
| <pre>
| |
| days = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"}
| |
| print(next(days))
| |
| print(next(days,4))
| |
| | |
| Will result in:
| |
| 1 Sunday
| |
| 5 Thursday -- cf. print(days[4]), which gives you Wednesday
| |
| </pre>
| |
| }}
| |
| | |
| | |
| '''pairs (t)'''
| |
| | |
| | |
| Returns three values: the next function, the table t, and nil, so that the construction
| |
| | |
| for k,v in pairs(t) do body end
| |
| | |
| will iterate over all key–value pairs of table t.
| |
| | |
| See function next for the caveats of modifying the table during its traversal.
| |
| | |
| | |
| '''pcall (f, arg1, ···)'''
| |
| | |
| | |
| Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated; instead, pcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message.
| |
| | |
| {{Example|
| |
| <pre>
| |
| if pcall (function() print("Hi Mom!") end) then
| |
| else print("There were errors")
| |
| end
| |
| | |
| Will result in:
| |
| Hi Mom!
| |
| </pre>
| |
| <pre>
| |
| if pcall (function() ppppprint("Hi Mom!") end) then
| |
| else print("There were errors")
| |
| end
| |
| | |
| Will result in:
| |
| There were errors
| |
| </pre>
| |
| }}
| |
| | |
| '''print (···)'''
| |
| | |
| | |
| Receives any number of arguments, and prints their values to stdout, using the tostring function to convert them to strings. print is not intended for formatted output, but only as a quick way to show a value, typically for debugging. For formatted output, use string.format.
| |
| | |
| {{Example|
| |
| <pre>
| |
| print ("Hello!")
| |
| | |
| Will result in:
| |
| Hello!
| |
| </pre>
| |
| }}
| |
| | |
| '''rawequal (v1, v2)'''
| |
| | |
| | |
| Checks whether v1 is equal to v2, without invoking any metamethod. Returns a boolean.
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(rawequal (5, 3))
| |
| | |
| Will result in:
| |
| false
| |
| </pre>
| |
| <pre>
| |
| print(rawequal (5, 5))
| |
| | |
| Will result in:
| |
| true
| |
| </pre>
| |
| }}
| |
| | |
| '''rawget (table, index)'''
| |
| | |
| | |
| Gets the real value of table[index], without invoking any metamethod. table must be a table; index may be any value.
| |
| | |
| {{Example|
| |
| <pre>
| |
| days = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"}
| |
| print(rawget (days, 2))
| |
| | |
| Will result in:
| |
| Monday
| |
| </pre>
| |
| }}
| |
| | |
| '''rawset (table, index, value)'''
| |
| | |
| | |
| Sets the real value of table[index] to value, without invoking any metamethod. table must be a table, index any value different from nil, and value any Lua value.
| |
| | |
| This function returns table.
| |
| | |
| {{Example|
| |
| <pre>
| |
| messages = {}
| |
| rawset (messages, 3, "Hi mom!")
| |
| print(rawget(messages,3)) -- notice this is rawget (see above)
| |
| | |
| Will result in:
| |
| Hi mom!
| |
| </pre>
| |
| }}
| |
| | |
| '''select (index, ···)'''
| |
| | |
| | |
| If index is a number, returns all arguments after argument number index. Otherwise, index must be the string "#", and select returns the total number of extra arguments it received.
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(select (3, "a", "b", "c", "d", "e", 1, 2, 3))
| |
| | |
| Will result in:
| |
| c d e 1 2 3
| |
| </pre>
| |
| }}
| |
| | |
| '''setfenv (f, table)'''
| |
| | |
| | |
| Sets the environment to be used by the given function. f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling setfenv. setfenv returns the given function.
| |
| | |
| As a special case, when f is 0 setfenv changes the environment of the running thread. In this case, setfenv returns no values.
| |
| | |
| {{Example|
| |
| <pre>
| |
| _G.a = 1 -- create a global variable
| |
| setfenv(1, {_G = _G}) -- change current environment
| |
| _G.print(a) --> nil
| |
| _G.print(_G.a) --> 1
| |
| | |
| Will result in:
| |
| nil 1
| |
| [http://www.lua.org/pil/14.3.html] | |
| </pre>
| |
| }}
| |
| | |
| '''setmetatable (table, metatable)'''
| |
| | |
| | |
| Sets the metatable for the given table. (You cannot change the metatable of other types from Lua, only from C.) If metatable is nil, removes the metatable of the given table. If the original metatable has a "__metatable" field, raises an error.
| |
| | |
| This function returns table.
| |
| | |
| | |
| '''tonumber (e [, base])'''
| |
| | |
| | |
| Tries to convert its argument to a number. If the argument is already a number or a string convertible to a number, then tonumber returns this number; otherwise, it returns nil.
| |
| | |
| An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35. In base 10 (the default), the number may have a decimal part, as well as an optional exponent part (see §2.1). In other bases, only unsigned integers are accepted.
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(tonumber (11111111, 2))
| |
| | |
| Will result in:
| |
| 255
| |
| </pre>
| |
| <pre>
| |
| print(tonumber ("FF", 16))
| |
| | |
| Will result in:
| |
| 255
| |
| </pre>
| |
| }}
| |
| | |
| '''tostring (e)'''
| |
| | |
| | |
| Receives an argument of any type and converts it to a string in a reasonable format. For complete control of how numbers are converted, use string.format.
| |
| | |
| If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as argument, and uses the result of the call as its result.
| |
| | |
| {{Example|
| |
| <pre>
| |
| a=tostring("The answer to 2+2 is " .. 2+2)
| |
| print(a)
| |
| | |
| Will result in:
| |
| The answer to 2+2 is 4
| |
| </pre>
| |
| }}
| |
| | |
| '''type (v)'''
| |
| | |
| | |
| Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".
| |
| | |
| unpack (list [, i [, j]])
| |
| Returns the elements from the given table. This function is equivalent to
| |
| | |
| return list[i], list[i+1], ···, list[j]
| |
| | |
| except that the above code can be written only for a fixed number of elements. By default, i is 1 and j is the length of the list, as defined by the length operator (see §2.5.5).
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(type (true))
| |
| | |
| Will result in:
| |
| boolean
| |
| </pre>
| |
| <pre>
| |
| print(type (3))
| |
| | |
| Will result in:
| |
| number
| |
| </pre>
| |
| }}
| |
| | |
| '''_VERSION'''
| |
| | |
| | |
| A global variable (not a function) that holds a string containing the current interpreter version. The current contents of this variable is "Lua 5.1".
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(_VERSION)
| |
| | |
| Results in:
| |
| Lua 5.1
| |
| </pre>
| |
| }}
| |
| | |
| '''xpcall (f, err)'''
| |
| | |
| | |
| This function is similar to pcall, except that you can set a new error handler.
| |
| | |
| xpcall calls function f in protected mode, using err as the error handler. Any error inside f is not propagated; instead, xpcall catches the error, calls the err function with the original error object, and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In this case, xpcall also returns all results from the call, after this first result. In case of any error, xpcall returns false plus the result from err.
| |
| ----
| |
| | |
| ==[http://www.lua.org/pil/9.1.html Coroutine] Manipulation==
| |
| | |
| The operations related to coroutines comprise a sub-library of the basic library and come inside the table coroutine. See §2.11 for a general description of coroutines.
| |
| | |
| | |
| '''coroutine.create (f)'''
| |
| | |
| | |
| Creates a new coroutine, with body f. f must be a Lua function. Returns this new coroutine, an object with type "thread".
| |
| | |
| {{Example|
| |
| <pre>
| |
| co = coroutine.create(function ()
| |
| print("Hi Mom!")
| |
| end)
| |
| print(co)
| |
| | |
| Will result in something similar to:
| |
| thread: 0A7CE80C
| |
| </pre>
| |
| }}
| |
| | |
| '''coroutine.resume (co [, val1, ···])'''
| |
| | |
| | |
| Starts or continues the execution of coroutine co. The first time you resume a coroutine, it starts running its body. The values val1, ··· are passed as the arguments to the body function. If the coroutine has yielded, resume restarts it; the values val1, ··· are passed as the results from the yield.
| |
| | |
| If the coroutine runs without any errors, resume returns true plus any values passed to yield (if the coroutine yields) or any values returned by the body function (if the coroutine terminates). If there is any error, resume returns false plus the error message.
| |
| | |
| {{Example|
| |
| <pre>
| |
| co = coroutine.create(function ()
| |
| print("Hi Mom!")
| |
| end)
| |
| coroutine.resume(co)
| |
| | |
| Will result in:
| |
| Hi Mom!
| |
| </pre>
| |
| }}
| |
| | |
| '''coroutine.running ()'''
| |
| | |
| | |
| Returns the running coroutine, or nil when called by the main thread.
| |
| | |
| {{Example|
| |
| <pre>
| |
| co = coroutine.create(function ()
| |
| print("Hi Mom!")
| |
| end)
| |
| print(coroutine.running ())
| |
| | |
| Will result in something similar to:
| |
| thread: 0A7A177C
| |
| </pre>
| |
| }}
| |
| | |
| '''coroutine.status (co)'''
| |
| | |
| | |
| Returns the status of coroutine co, as a string: "running", if the coroutine is running (that is, it called status); "suspended", if the coroutine is suspended in a call to yield, or if it has not started running yet; "normal" if the coroutine is active but not running (that is, it has resumed another coroutine); and "dead" if the coroutine has finished its body function, or if it has stopped with an error.
| |
| | |
| {{Example|
| |
| <pre>
| |
| co = coroutine.create(function ()
| |
| print("Hi Mom!")
| |
| end)
| |
| print(coroutine.status (co))
| |
| | |
| Will result in:
| |
| Suspended
| |
| </pre>
| |
| }}
| |
| | |
| '''coroutine.wrap (f)'''
| |
| | |
| | |
| Creates a new coroutine, with body f. f must be a Lua function. Returns a function that resumes the coroutine each time it is called. Any arguments passed to the function behave as the extra arguments to resume. Returns the same values returned by resume, except the first boolean. In case of error, propagates the error.
| |
| | |
| {{Example|
| |
| <pre>
| |
| print(coroutine.wrap (function()
| |
| print("Hi Mom!")
| |
| end))
| |
| | |
| Will result in something similar to:
| |
| function: 0EFAB5D0
| |
| </pre>
| |
| }}
| |
| | |
| '''coroutine.yield (···)'''
| |
| | |
| | |
| Suspends the execution of the calling coroutine. The coroutine cannot be running a C function, a metamethod, or an iterator. Any arguments to yield are passed as extra results to resume.
| |
| | |
| {{Example|
| |
| <pre>
| |
| co = coroutine.create (function ()
| |
| print(coroutine.yield())
| |
| end)
| |
| coroutine.resume(co)
| |
| coroutine.resume(co, 4, 5)
| |
| | |
| Will result in:
| |
| 4 5
| |
| </pre>
| |
| }}
| |
| | |
| See:<br>
| |
| [http://www.lua.org/pil/9.1.html Programming in Lua: Coroutine Basics]
| |
| ----
| |
| | |
| ==String Manipulation==
| |
| | |
| This library provides generic functions for string manipulation, such as finding and extracting substrings, and pattern matching. When indexing a string in Lua, the first character is at position 1 (not at 0, as in C). Indices are allowed to be negative and are interpreted as indexing backwards, from the end of the string. Thus, the last character is at position -1, and so on.
| |
| | |
| The string library provides all its functions inside the table string. It also sets a metatable for strings where the __index field points to the string table. Therefore, you can use the string functions in object-oriented style. For instance, string.byte(s, i) can be written as s:byte(i).
| |
| | |
| | |
| '''string.byte (s [, i [, j]])'''
| |
| | |
| | |
| Returns the internal numerical codes of the characters s[i], s[i+1], ···, s[j]. The default value for i is 1; the default value for j is i.
| |
| | |
| Note that numerical codes are not necessarily portable across platforms.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.byte ("abc", 1, 3))<br>
| |
| Will result in:
| |
| 97 98 99
| |
| }}
| |
| | |
| '''string.char (···)'''
| |
| | |
| | |
| Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the internal numerical code equal to its corresponding argument.
| |
| | |
| Note that numerical codes are not necessarily portable across platforms.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.char (97, 98, 99, 100))<br>
| |
| Will result in:
| |
| abcd
| |
| }}
| |
| | |
| '''string.dump (function)'''
| |
| | |
| | |
| Returns a string containing a binary representation of the given function, so that a later loadstring on this string returns a copy of the function. function must be a Lua function without upvalues.
| |
| | |
| {{Example|1=<i></i>
| |
| function F()
| |
| a=2
| |
| return a
| |
| end<br>
| |
| S = string.dump(F)
| |
| print(S)<br>
| |
| Will result in:
| |
| �LuaQ
| |
| }}
| |
| | |
| '''string.find (s, pattern [, init [, plain]])'''
| |
| | |
| | |
| Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and may be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well.
| |
| | |
| If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.find ("blahblah", "bla"))<br>
| |
| Will result in:
| |
| 1 3
| |
| }}
| |
| | |
| '''string.format (formatstring, ···)'''
| |
| | |
| | |
| Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string). The format string follows the same rules as the printf family of standard C functions. The only differences are that the options/modifiers *, l, L, n, p, and h are not supported and that there is an extra option, q. The q option formats a string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written. For instance, the call
| |
| | |
| string.format('%q', 'a string with "quotes" and \n new line')
| |
| | |
| will produce the string:
| |
| | |
| "a string with \"quotes\" and \
| |
| new line"
| |
| | |
| The options c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument, whereas q and s expect a string.
| |
| | |
| This function does not accept string values containing embedded zeros, except as arguments to the q option.
| |
| | |
| | |
| '''string.gmatch (s, pattern)'''
| |
| | |
| | |
| Returns an iterator function that, each time it is called, returns the next captures from pattern over string s. If pattern specifies no captures, then the whole match is produced in each call.
| |
| | |
| As an example, the following loop
| |
| | |
| s = "hello world from Lua"
| |
| for w in string.gmatch(s, "%a+") do
| |
| print(w)
| |
| end
| |
| | |
| will iterate over all the words from string s, printing one per line. The next example collects all pairs key=value from the given string into a table:
| |
| | |
| t = {}
| |
| s = "from=world, to=Lua"
| |
| for k, v in string.gmatch(s, "(%w+)=(%w+)") do
| |
| t[k] = v
| |
| end
| |
| | |
| For this function, a '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.
| |
| | |
| | |
| '''string.gsub (s, pattern, repl [, n])'''
| |
| | |
| | |
| Returns a copy of s in which all (or the first n, if given) occurrences of the pattern have been replaced by a replacement string specified by repl, which may be a string, a table, or a function. gsub also returns, as its second value, the total number of matches that occurred.
| |
| | |
| If repl is a string, then its value is used for replacement. The character % works as an escape character: any sequence in repl of the form %n, with n between 1 and 9, stands for the value of the n-th captured substring (see below). The sequence %0 stands for the whole match. The sequence %% stands for a single %.
| |
| | |
| If repl is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.
| |
| | |
| If repl is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.
| |
| | |
| If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).
| |
| | |
| Here are some examples:
| |
| | |
| x = string.gsub("hello world", "(%w+)", "%1 %1")
| |
| --> x="hello hello world world"
| |
|
| |
| x = string.gsub("hello world", "%w+", "%0 %0", 1)
| |
| --> x="hello hello world"
| |
|
| |
| x = string.gsub("hello world from Lua", "(%w+)%s*(%w+)", "%2 %1")
| |
| --> x="world hello Lua from"
| |
|
| |
| x = string.gsub("home = $HOME, user = $USER", "%$(%w+)", os.getenv)
| |
| --> x="home = /home/roberto, user = roberto"
| |
|
| |
| x = string.gsub("4+5 = $return 4+5$", "%$(.-)%$", function (s)
| |
| return loadstring(s)()
| |
| end)
| |
| --> x="4+5 = 9"
| |
|
| |
| local t = {name="lua", version="5.1"}
| |
| x = string.gsub("$name-$version.tar.gz", "%$(%w+)", t)
| |
| --> x="lua-5.1.tar.gz"
| |
| | |
| | |
| '''string.len (s)'''
| |
| | |
| | |
| Receives a string and returns its length. The empty string "" has length 0. Embedded zeros are counted, so "a\000bc\000" has length 5.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.len (""))
| |
| print(string.len ("a"))
| |
| print(string.len ("ab"))
| |
| print(string.len ("abc"))<br>
| |
| Will result in:
| |
| 0
| |
| 1
| |
| 2
| |
| 3
| |
| }}
| |
| | |
| '''string.lower (s)'''
| |
| | |
| | |
| Receives a string and returns a copy of this string with all uppercase letters changed to lowercase. All other characters are left unchanged. The definition of what an uppercase letter is depends on the current locale.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.lower ("Hi Mom!"))<br>
| |
| Will result in:
| |
| hi mom!
| |
| }}
| |
| | |
| '''string.match (s, pattern [, init])'''
| |
| | |
| | |
| Looks for the first match of pattern in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numerical argument init specifies where to start the search; its default value is 1 and may be negative.
| |
| | |
| | |
| '''string.rep (s, n)'''
| |
| | |
| | |
| Returns a string that is the concatenation of n copies of the string s.
| |
| | |
| | |
| '''string.reverse (s)'''
| |
| | |
| | |
| Returns a string that is the string ''s'' reversed.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.reverse ("!moM ,olleH"))<br>
| |
| Will result in:
| |
| Hello, Mom!
| |
| }}
| |
| | |
| | |
| '''string.sub (s, i [, j])'''
| |
| | |
| | |
| Returns the substring of s that starts at i and continues until j; i and j may be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.sub ("Hi Mom!", 1, 4))<br>
| |
| Will result in:
| |
| Hi M
| |
| | |
| print(string.sub ("Hi Mom!", 1))<br>
| |
| Will result in
| |
| Hi Mom!
| |
| }}
| |
| | |
| '''string.upper (s)'''
| |
| | |
| | |
| Receives a string and returns a copy of this string with all lowercase letters changed to uppercase. All other characters are left unchanged. The definition of what a lowercase letter is depends on the current locale.
| |
| | |
| {{Example|1=<i></i>
| |
| print(string.upper ("Hi Mom!"))<br>
| |
| Will result in:
| |
| HI MOM!
| |
| }}
| |
| | |
| ===Patterns===
| |
| Character Class:
| |
| | |
| A character class is used to represent a set of characters. The following combinations are allowed in describing a character class:
| |
| | |
| * '''x''' (where x is not one of the magic characters ^$()%.[]*+-?) represents the character x itself.
| |
| * '''.''' (a dot) represents all characters.
| |
| * '''%a''' represents all letters.
| |
| * '''%c''' represents all control characters.
| |
| * '''%d''' represents all digits.
| |
| * '''%l''' represents all lowercase letters.
| |
| * '''%p''' represents all punctuation characters.
| |
| * '''%s''' represents all space characters.
| |
| * '''%u''' represents all uppercase letters.
| |
| * '''%w''' represents all alphanumeric characters.
| |
| * '''%x''' represents all hexadecimal digits.
| |
| * '''%z''' represents the character with representation 0.
| |
| * '''%x''' (where x is any non-alphanumeric character) represents the character x. This is the standard way to escape the magic characters. Any punctuation character (even the non magic) can be preceded by a '%' when used to represent itself in a pattern.
| |
| * '''[set]''' represents the class which is the union of all characters in set. A range of characters may be specified by separating the end characters of the range with a '-'. All classes %x described above may also be used as components in set. All other characters in set represent themselves. For example, [%w_] (or [_%w]) represents all alphanumeric characters plus the underscore, [0-7] represents the octal digits, and [0-7%l%-] represents the octal digits plus the lowercase letters plus the '-' character.
| |
| | |
| The interaction between ranges and classes is not defined. Therefore, patterns like [%a-z] or [a-%%] have no meaning.
| |
| * '''[^set]''' represents the complement of set, where set is interpreted as above.
| |
| | |
| For all classes represented by single letters (%a, %c, etc.), the corresponding uppercase letter represents the complement of the class. For instance, %S represents all non-space characters.
| |
| | |
| The definitions of letter, space, and other character groups depend on the current locale. In particular, the class [a-z] may not be equivalent to %l.
| |
| Pattern Item:
| |
| | |
| A pattern item may be
| |
| | |
| * a single character class, which matches any single character in the class;
| |
| * a single character class followed by '*', which matches 0 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
| |
| * a single character class followed by '+', which matches 1 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
| |
| * a single character class followed by '-', which also matches 0 or more repetitions of characters in the class. Unlike '*', these repetition items will always match the shortest possible sequence;
| |
| * a single character class followed by '?', which matches 0 or 1 occurrence of a character in the class;
| |
| * %n, for n between 1 and 9; such item matches a substring equal to the n-th captured string (see below);
| |
| * %bxy, where x and y are two distinct characters; such item matches strings that start with x, end with y, and where the x and y are balanced. This means that, if one reads the string from left to right, counting +1 for an x and -1 for a y, the ending y is the first y where the count reaches 0. For instance, the item %b() matches expressions with balanced parentheses.
| |
| | |
| Pattern:
| |
| | |
| A pattern is a sequence of pattern items. A '^' at the beginning of a pattern anchors the match at the beginning of the subject string. A '$' at the end of a pattern anchors the match at the end of the subject string. At other positions, '^' and '$' have no special meaning and represent themselves.
| |
| Captures:
| |
| | |
| A pattern may contain sub-patterns enclosed in parentheses; they describe captures. When a match succeeds, the substrings of the subject string that match captures are stored (captured) for future use. Captures are numbered according to their left parentheses. For instance, in the pattern "(a*(.)%w(%s*))", the part of the string matching "a*(.)%w(%s*)" is stored as the first capture (and therefore has number 1); the character matching "." is captured with number 2, and the part matching "%s*" has number 3.
| |
| | |
| As a special case, the empty capture () captures the current string position (a number). For instance, if we apply the pattern "()aa()" on the string "flaaap", there will be two captures: 3 and 5.
| |
| | |
| A pattern cannot contain embedded zeros. Use %z instead.
| |
| | |
| | |
| | |
| ----
| |
| | |
| ==Table Manipulation==
| |
| | |
| This library provides generic functions for table manipulation. It provides all its functions inside the table table.
| |
| | |
| Most functions in the table library assume that the table represents an array or a list. For these functions, when we talk about the "length" of a table we mean the result of the length operator.
| |
| | |
| | |
| '''table.concat (table [, sep [, i [, j]]])'''
| |
| | |
| | |
| Given an array where all elements are strings or numbers, returns table[i]..sep..table[i+1] ··· sep..table[j]. The default value for sep is the empty string, the default for i is 1, and the default for j is the length of the table. If i is greater than j, returns the empty string.
| |
| | |
| | |
| '''table.insert (table, [pos,] value)'''
| |
| | |
| | |
| Inserts element value at position pos in table, shifting up other elements to open space, if necessary. The default value for pos is n+1, where n is the length of the table (see §2.5.5), so that a call table.insert(t,x) inserts x at the end of table t.
| |
| | |
| | |
| '''table.maxn (table)'''
| |
| | |
| | |
| Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices. (To do its job this function does a linear traversal of the whole table.)
| |
| | |
| {{Example|1=<i></i>
| |
| numbers = {0, 1, 2, 3, 4, 5, 6}
| |
| print(table.maxn (numbers))<br>
| |
| Will result in:
| |
| 7
| |
| }}
| |
| | |
| '''table.remove (table [, pos])'''
| |
| | |
| | |
| Removes from table the element at position pos, shifting down other elements to close the space, if necessary. Returns the value of the removed element. The default value for pos is n, where n is the length of the table, so that a call table.remove(t) removes the last element of table t.
| |
| | |
| {{Example|1=<i></i>
| |
| numbers = {0, 1, 2, 3, 4, 5, 6}
| |
| print (numbers[4])
| |
| table.remove (numbers, 4)
| |
| print (numbers[4])<br>
| |
| Will result in:
| |
| 3 4
| |
| }}
| |
| | |
| '''table.sort (table [, comp])'''
| |
| | |
| | |
| Sorts table elements in a given order, in-place, from table[1] to table[n], where n is the length of the table. If comp is given, then it must be a function that receives two table elements, and returns true when the first is less than the second (so that not comp(a[i+1],a[i]) will be true after the sort). If comp is not given, then the standard Lua operator < is used instead.
| |
| | |
| The sort algorithm is not stable; that is, elements considered equal by the given order may have their relative positions changed by the sort.
| |
| | |
| ----
| |
| | |
| ==Mathematical Functions==
| |
| | |
| This library is an interface to the standard C math library. It provides all its functions inside the table math.
| |
| | |
| | |
| '''math.abs (x)'''
| |
| | |
| | |
| Returns the absolute value of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.abs(-5))<br>
| |
| Will result in:
| |
| 5
| |
| }}
| |
| | |
| '''math.acos (x)'''
| |
| | |
| | |
| Returns the arc cosine of x (in radians).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.acos(-1))<br>
| |
| Will result in:
| |
| 3.1415926535898
| |
| }}
| |
| | |
| '''math.asin (x)'''
| |
| | |
| | |
| Returns the arc sine of x (in radians).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.asin(0))<br>
| |
| Will result in:
| |
| 0
| |
| }}
| |
| | |
| '''math.atan (x)'''
| |
| | |
| | |
| Returns the arc tangent of x (in radians).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.atan(math.pi))<br>
| |
| Will result in:
| |
| 1.2626272556789
| |
| }}
| |
| | |
| '''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.
| |
| | |
| {{Example|1=<i></i>
| |
| z=math.ceil (4.2)
| |
| print(z)<br>
| |
| Will result in:
| |
| 5
| |
| }}
| |
| | |
| '''math.cos (x)'''
| |
| | |
| | |
| | |
| Returns the cosine of x (assumed to be in radians).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.cos (1))<br>
| |
| Will result in:
| |
| 0.54030230586814
| |
| }}
| |
| | |
| '''math.cosh (x)'''
| |
| | |
| | |
| Returns the hyperbolic cosine of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.cosh (1))<br>
| |
| Will result in:
| |
| 1.5430806348152
| |
| }}
| |
| | |
| ''''math.deg (x)'''
| |
| | |
| | |
| Returns the angle x (given in radians) in degrees.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.deg (1.5707963267948966192313216916398))<br>
| |
| Will result in:
| |
| 90
| |
| }}
| |
| | |
| '''math.exp (x)'''
| |
| | |
| | |
| Returns the the value e^x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.exp (1))<br>
| |
| Will result in:
| |
| 2.718281828459
| |
| }}
| |
| | |
| '''math.floor (x)'''
| |
| | |
| | |
| Returns the largest integer smaller than or equal to x.
| |
| | |
| {{Example|1=<i></i>
| |
| z=math.ceil (4.2)
| |
| print(z)<br>
| |
| Will result in:
| |
| 4
| |
| }}
| |
| | |
| '''math.fmod (x, y)'''
| |
| | |
| | |
| Returns the remainder of the division of x by y that rounds the quotient towards zero.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.fmod (10, 3))<br>
| |
| Will result in:
| |
| 1
| |
| }}
| |
| | |
| '''math.frexp (x)'''
| |
| | |
| | |
| Returns m and e such that x = m*2^e, e is an integer and the absolute value of m is in the range [0.5, 1) (or zero when x is zero).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.frexp (0))<br>
| |
| Will result in:
| |
| 0 0
| |
| | |
| print(math.frexp (4))<br>
| |
| Will result in:
| |
| 0.5 3 -- (2^3/2=4)
| |
| }}
| |
| | |
| '''math.huge'''
| |
| | |
| | |
| The value HUGE_VAL, a value larger than or equal to any other numerical value.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.huge)<br>
| |
| Will result in:
| |
| 1.#INF
| |
| }}
| |
| | |
| '''math.ldexp (m, e)'''
| |
| | |
| | |
| Returns m*2^e (e should be an integer).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.ldexp (2, 6))<br>
| |
| Will result in:
| |
| 128 (i.e., (2*(2^6))
| |
| }}
| |
| | |
| | |
| '''math.log (x)'''
| |
| | |
| | |
| Returns the natural logarithm of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.log (2.71828182845904523536))<br>
| |
| Will result in:
| |
| 1
| |
| }}
| |
| | |
| '''math.log10 (x)'''
| |
| | |
| | |
| Returns the base-10 logarithm of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.log10 (100))<br>
| |
| Will result in:
| |
| 2
| |
| }}
| |
| | |
| '''math.max (x, ···)'''
| |
| | |
| | |
| Returns the maximum value among its arguments.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.max (1, 2, 3, 4, 5, 6, 7))<br>
| |
| Will result in:
| |
| 7
| |
| }}
| |
| | |
| '''math.min (x, ···)'''
| |
| | |
| | |
| Returns the minimum value among its arguments.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.min (1, 2, 3, 4, 5, 6, 7))<br>
| |
| Will result in:
| |
| 1
| |
| }}
| |
| | |
| '''math.modf (x)'''
| |
| | |
| | |
| Returns two numbers, the integral part of x and the fractional part of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.modf (2.5))<br>
| |
| Will result in:
| |
| 2 0.5
| |
| }}
| |
| | |
| '''math.pi'''
| |
| | |
| | |
| The value of pi.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.pi)<br>
| |
| Will result in:
| |
| 3.1415926535898
| |
| }}
| |
| | |
| '''math.pow (x, y)'''
| |
| | |
| | |
| Returns x^y. (You can also use the expression x^y to compute this value.)
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.pow (4, 2))<br>
| |
| Will result in:
| |
| 16
| |
| }}
| |
| | |
| '''math.rad (x)'''
| |
| | |
| | |
| Returns the angle x (given in degrees) in radians.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.rad (90))<br>
| |
| Will result in:
| |
| 1.5707963267949 (Which is pi/2)
| |
| }}
| |
| | |
| '''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].
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.random (0, 10))<br>
| |
| Might result in:
| |
| 7
| |
| }}
| |
| | |
| '''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).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.sin (1.5707963267948966192313216916398))<br>
| |
| Will result in:
| |
| 1
| |
| }}
| |
| | |
| '''math.sinh (x)'''
| |
| | |
| | |
| Returns the hyperbolic sine of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.sinh (0))<br>
| |
| Will result in:
| |
| 0
| |
| }}
| |
| | |
| '''math.sqrt (x)'''
| |
| | |
| | |
| Returns the square root of x. (You can also use the expression x^0.5 to compute this value.)
| |
| | |
| {{Example|1=<i></i>
| |
| z=math.sqrt (16)
| |
| print(z)<br>
| |
| Will result in:
| |
| 4
| |
| }}
| |
| | |
| '''math.tan (x)'''
| |
| | |
| | |
| Returns the tangent of x (assumed to be in radians).
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.tan (1)) <br>
| |
| Will result in:
| |
| 1.5574077246549
| |
| }}
| |
| | |
| '''math.tanh (x)'''
| |
| | |
| | |
| Returns the hyperbolic tangent of x.
| |
| | |
| {{Example|1=<i></i>
| |
| print(math.tanh (1))<br>
| |
| Will result in:
| |
| 0.76159415595576
| |
| }}
| |
| | |
| ----
| |
|
| |
|
| [[Category:Reference Pages]] | | [[Category:Reference Pages]] |
