additional_docs.lua File Reference

Classes
class	table
	Lua's built in table library. More...
class	coroutine
	Lua's built in microthread library. More...
class	debug
	Lua's built in debugging library. More...
class	file
	Lua's built in file library. More...
class	io
	Lua's built in input output library. More...
class	math
	Lua's built in math library. More...
class	os
	Lua's built in os library. More...
class	string
	Lua's built in string library. More...

Functions
function	dofile (filename)
	executes as Lua chunk, default stdin, returns value More...
function	error (message[, level])
	terminates protected func, never returns, level 1 (default), 2=parent More...
function	pairs (t)
	returns a string with a filename for a temporary file (dangerous! tmpfile is better) More...
function	pcall (f, arg1, arg2,...)
	returns the next function and table t plus a nil, iterates over all key-value pairs More...
function	print (e1, e2,...)
	protected mode call, catches errors, returns status code first (true=success) More...
function	rawequal (v1, v2)
	prints values to stdout using tostring More...
function	rawget (table, index)
function	rawset (table, index, value)
	non-metamethod get value of table[index], index != nil More...
function	require (packagename)
	non-metamethod set value of table[index], index != nil More...
function	setfenv (f, table)
	loads package, updates _LOADED, returns boolean More...
function	setmetatable (table, metatable) sets metatable
	sets env, f can be a function or number (stack level, default=1), 0=global env More...
function	ipairs (t)
	returns an iterator function, table t and 0 More...
function	loadfile (filename)
	loads chunk without execution, returns chunk as function, else nil plus error More...
function	loadlib (libname, funcname)
	links to dynamic library libname, returns funcname as a C function More...
function	loadstring (string[, chunkname])
	loads string as chunk, returns chunk as function, else nil plus error More...
function	next (table[, index])
	returns next index,value pair, if index=nil (default), returns first index More...
function	assert (v[, message])
	error if v nil or false, otherwise returns v More...
function	collectgarbage ([limit])
	set threshold to limit KBytes, default 0, may run GC More...
function	tonumber (e[, base])
	convert to number, returns number, nil if non-convertible, 2<=base<=36 More...
function	tostring (e)
	convert to string, returns string More...
function	type (v)
	returns type of v as a string More...
function	unpack (list)
	returns all elements from list More...
function	xpcall (f, err)
	pcall function f with new error handler err More...
function	gcinfo ()
	returns dynamic mem in use (KB), and current GC threshold (KB) More...
function	getfenv (f)
	gets env, f can be a function or number (stack level, default=1), 0=global env More...
function	getmetatable (object)
	returns metatable of given object, otherwise nil More...

Variables
function nil to remove	metatable

Function Documentation

function assert

(

v

[, message]

)

error if v nil or false, otherwise returns v

function collectgarbage

(

)

set threshold to limit KBytes, default 0, may run GC

function dofile

(

filename

)

executes as Lua chunk, default stdin, returns value

function error

(

message

[, level]

)

terminates protected func, never returns, level 1 (default), 2=parent

function gcinfo

(

)

returns dynamic mem in use (KB), and current GC threshold (KB)

function getfenv

(

f

)

gets env, f can be a function or number (stack level, default=1), 0=global env

function getmetatable

(

object

)

returns metatable of given object, otherwise nil

function ipairs

(

t

)

returns an iterator function, table t and 0

function loadfile

(

filename

)

loads chunk without execution, returns chunk as function, else nil plus error

function loadlib	(	libname	,
		funcname
	)

links to dynamic library libname, returns funcname as a C function

function loadstring

(

string

[, chunkname]

)

loads string as chunk, returns chunk as function, else nil plus error

function next

(

table

[, index]

)

returns next index,value pair, if index=nil (default), returns first index

function pairs

(

t

)

returns a string with a filename for a temporary file (dangerous! tmpfile is better)

function pcall	(	f	,
		arg1	,
		arg2	,
			...
	)

returns the next function and table t plus a nil, iterates over all key-value pairs

function print	(	e1	,
		e2	,
			...
	)

protected mode call, catches errors, returns status code first (true=success)

function rawequal	(	v1	,
		v2
	)

prints values to stdout using tostring

function rawget	(	table	,
		index
	)

function rawset	(	table	,
		index	,
		value
	)

non-metamethod get value of table[index], index != nil

function require

(

packagename

)

non-metamethod set value of table[index], index != nil

function setfenv	(	f	,
		table
	)

loads package, updates _LOADED, returns boolean

function setmetatable	(	table	,
		metatable
	)

sets env, f can be a function or number (stack level, default=1), 0=global env

function tonumber

(

e

[, base]

)

convert to number, returns number, nil if non-convertible, 2<=base<=36

function luaFocusStack tostring

(

e

)

convert to string, returns string

function type

(

v

)

returns type of v as a string

function unpack

(

list

)

returns all elements from list

function xpcall	(	f	,
		err
	)

pcall function f with new error handler err

Variable Documentation

function nil to remove metatable