Variables

Variable List

band

Performs a bitwise AND operation. Used for checking flags.

Parameters

• x
• y

bit.band(x,y)

clear

Stops a timer that was created with setInterval.

Parameters

• id

timer.clear(id)

clock

Returns the CPU time used by the program in seconds.

os.clock()

date

Formats a date and time.

os.date()

decode

Decodes a JSON string into a Lua table.

Parameters

• jsonString

json.decode(jsonString)

encode

Encodes a Lua table into a JSON string.

Parameters

• dataTable

json.encode(dataTable)

execute

Executes a system command. Use with extreme caution.

Parameters

• command

os.execute(command)

exit

Exits the script immediately.

Parameters

• code

os.exit(code)

get

Performs an HTTP GET request. Must be wrapped in a coroutine.

Parameters

• url
• headers

http.get(url,headers)

getenv

Gets an environment variable.

Parameters

• varname

os.getenv(varname)

lshift

Performs a left bitwise shift. Used for creating bit flags.

Parameters

• x
• n

bit.lshift(x,n)

post

Performs an HTTP POST request. Must be wrapped in a coroutine.

Parameters

• url
• headers
• postData

http.post(url,headers,postData)

remove

Deletes a file.

Parameters

• filename

os.remove(filename)

rename

Renames a file.

Parameters

• oldname
• newname

os.rename(oldname,newname)

setInterval

Executes a function repeatedly at a specified interval. Returns an ID to be used with timer.clear.

Parameters

• interval_seconds
• function

timer.setInterval(interval_seconds,function)

setlocale

Sets the program locale.

Parameters

• locale
• category

os.setlocale(locale,category)

setTimeout

Executes a function once after a specified delay. Additional arguments are passed to the function.

Parameters

• delay_seconds
• function
• ...args

timer.setTimeout(delay_seconds,function,...args)

time

Returns the current time as a Unix timestamp.

os.time()