Powered by

# base

This is an expansion to the existing Lua Base library.

# Functions

# base.assert(v: any, message?: string): any

base.assert(v: any, message?: string)
  • Raises an error if value of v is nil or false.
  • Message is optional, defaults to "assertion failed!".
  • If no error, returns the value v.

# base.collectgarbage(opt: string, arg?: any): number?

base.collectgarbage(opt: string, arg?: any): number?
  • Responsible for controlling and retrieving information about Lua's garbage collector.
"stop": stops the garbage collector.
"restart": restarts the garbage collector.
"collect": performs a full garbage-collection cycle (this is the default if no option supplied)
"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 below).
"setstepmul": sets arg/100 as the new value for the step multiplier of the collector (see below).

# base.error(message: string, level?: number)

base.error(message: string, level?: number)
  • Raises an error with the supplied message.
  • If a level is supplied the error points to the current function (level 1 or nil), the parent function (level 2) and so on.

# base.gcinfo()

base.gcinfo()
  • Returns Kb of dynamic memory in use.
base.error(message: string, level?: number)
  • Raises an error with the supplied message.
  • If a level is supplied the error points to the current function (level 1 or nil), the parent function (level 2) and so on.

# base.getfenv(f: number | function): table

base.getfenv(f: number | function): table
  • Returns the current environment used by the nominated function f.
  • f can be a function or a number representing the stack level, where 1 is the currently running function, 2 is its parent and so on.

# base.getmetatable(obj: table | function | userdata): table?

base.getmetatable(obj: table | function | userdata): table?
  • Returns metatable for the nominated object.

# base.ipairs(t: table): function, table, number

base.ipairs(t: table): function, table, number
  • Returns an iterator function, the table t, and 0, for use in the generic "for" loop.

# base.next(t: table, i?: index): any, any

base.next(t: table, i?: index): any, any
  • Traverses all entries in a table.
  • Returns the next index, value pair.
  • If index is nil (the default), returns the first pair.
  • When called with the last index of the table (or with an index of nil for an empty table), returns nil.

# base.pairs(t: table): function, table, any?

base.pairs(t: table): function, table, any?
  • Returns the 'next' function, the table t, and nil, for use in a for loop.

# base.pcall(f: function, ...: any): boolean, string | any, ...any

base.pcall(f: function, ...: any): boolean, string | any, ...any
  • Calls function f with the supplied arguments in protected mode.
  • Catches errors and returns.

# base.print(...: any)

base.print(...: any)
  • Prints its arguments to stdout

# base.rawequal(v1: any, v2: any): boolean

base.rawequal(v1: any, v2: any): boolean
  • Returns a boolean depending on v1 == v2 without invoking any table metamethods.

# base.rawget(t: table, i: any): any

base.rawget(t: table, i: any): any
  • Gets the real value of table [index] without invoking metamethods.

# base.rawset(t: table, i: any, v: any)

base.rawset(t: table, i: any, v: any)
  • Sets the value of table [index] to value, without invoking metamethods.

# base.select(index: string | number, ...: any): ...any

base.select(index: string | number, ...: any): ...any
  • If index is a number, returns all items in the list from that number onwards.
  • Otherwise index must be the string "#", in which case it returns the number of items in the list.

# base.setfenv(f: number | userdata | thread | function, env: table)

base.setfenv(f: number | userdata | thread | function, env: table)
  • Sets the current environment to be used by f, which can be a function, userdata, thread or stack level.
  • Level 1 is the current function.
  • Level 0 is the global environment of the current thread.
  • The "env" argument is a table, which effectively becomes the "root" for the environment.

# base.setmetatable(t: table, metatable: table): table

base.setmetatable(t: table, metatable: table): table
  • Sets the metatable for the nominated table.
  • If metatable is nil, removes the metatable.
  • If the original metatable has a "__metatable" entry an error is raised.

# base.tonumber(v: number | string, base?: number = 10): number

base.tonumber(v: number | string, base?: number = 10): number
  • Converts n to a number using the optional base (default 10), base can be from 2 to 36.
  • For bases > 10 the letters a-z (not case sensitive) represent the digits. (eg. F is 15).
  • For decimal numbers you can supply fractions and exponents. Others should be unsigned.
  • Returns nil if the number cannot be converted.

# base.tostring(v: any): string

base.tostring(v: any): string
  • Converts its argument to a string in a reasonable format.
  • If a __tostring metatable field is found, that is used for the conversion.

# base.type(v: any): string

base.type(v: any): string
  • Returns a string, which is the type.

# base.unpack(t: table): ...any

base.unpack(t: table): ...any
  • Returns all elements from the given list (table) as individual values.

# base.xpcall(f: function, err: function): boolean, any, ...any

base.xpcall(f: function, err: function): boolean, any, ...any
  • Calls function f with err as the custom error handler.
  • If an error occurs in f it is caught and the error-handler 'err' is called, then xpcall returns false, and whatever the error handler returned.
  • If there is no error in f, then xpcall returns true, followed by the function results from f.

© Copyright 2025. All rights reserved.