basic library

assert (v [, message])

Вызывает error, если значение аргумента v = false (т.е., nil или false); иначе, возвращает все свои аргументы. В случае ошибки, message — это объект ошибки; когда он отсутствует, его значение по умолчанию «assertion failed!»

collectgarbage ([opt [, arg]])

Эта функция общий интерфейс к сборщику мусора. Она выполняет различные действия в соответствии с её аргументом opt:

«collect»: выполняет полный цикл очистки мусора. Это опция по умолчанию.
«stop»: останавливает автоматическое выполнение сборщика мусора. Сборщик будет запущен, только когда явно вызван, до вызова его перезапуска.
«restart»: перезапускает автоматическое выполнение сборщика мусора.
«count»: возвращает общее количество используемой Lua памяти в килобайтах. Это значение имеет дробную часть, так что его произведение на 1024 дает точное количество байт, используемых Lua (за исключением переполнений).
«step»: выполняет шаг сборки мусора. «Размер» шага контролируется аргументом arg. С нулевым значением сборщик выполнит один базовый (неделимый) шаг. Для не нулевых значений, сборщик выполнит, как если это количество памяти (в килобайтах) было выделено Lua. Возвращает true, если шаг завершил цикл сборки.
«setpause»: устанавливает arg в качестве нового значения для паузы сборщика. Возвращает предыдущее значение паузы.
«setstepmul»: устанавливает arg в качестве нового значения для множителя шагов сборщика. Возвращает предыдущее значение шага.
«isrunning»: возвращает логическое значение, говорящее запущен ли сборщик (т.е. не остановлен).

dofile ([filename])

Открывает файл и запускает его содержимое, как Lua кусок. Когда вызвана без аргументов, запускает содержимое стандартного ввода (stdin). Возвращает все значения, возвращенные куском. В случае ошибок, dofile распространяет ошибку вызывающему коду (т.е. dofile не запускается в защищенном режиме).

error (message [, level])

Завершает последнюю защищенно-вызванную функцию и возвращает message, как объект ошибки. Функция error никогда не возвращается.

Обычно error добавляет информацию о позиции ошибки в начало сообщения, если сообщение (message) это строка. Аргумент level определяет как получить позицию ошибки. Когда level = 1 (по умолчанию) — позиция ошибки там, где вызвана функция error. Level = 2 — указывает ошибку там, где вызвана функция, вызвавшая error; и так далее. Передача level = 0 — позиция ошибки не включается в сообщение.

_G

Глобальная переменная (не функция), которая хранит глобальное окружение. Lua сама не использует эту переменную; её изменение не влияет на окружение, ни наоборот.

getmetatable (object)

Если object не имеет метатаблицы, возвращает nil. Иначе, если метатаблица объекта имеет поле "__metatable", возвращает ассоциированное с этим полем значение. Иначе, возвращает метатаблицу переданного объекта.

ipairs (t)

Возвращет три значения (функцию итератор, таблицу t и 0), так что конструкция for i,v in ipairs(t) do body end будет перебирать пары ключ–значение (1,t[1]), (2,t[2]), …, до первого значения nil.

next (table [, index])

Позволяет программе просмостреть все поля таблицы. Её первый аргумент — это таблица, второй аргумент — индекс в этой таблице. nextвозвращает следующий индекс таблицы и ассоциированное с ним значение. Когда вызывается с nil в качестве второго аргумента, next возвращает начальный индекс и ассоциированное с ним значение. Когда вызывается с последним индексом, или с nil для пустой таблицы, next возвращает nil. Если второй аргумент отсутствует, то он интерпретируется как nil. В частности, вы можете использовать next(t) для проверки, что таблица пустая.

Порядок перечисления индексов не определен, даже для числовых индексов. (Для просмотра таблицы в числовом порядке, используйте числовой for.)

Поведение next неопределено, если во время просмотра вы присваиваете любое значение несуществующему полю в таблице. Тем не менее вы можете модифицировать существующие поля. В частности, вы можете очищать существующие поля.

pairs (t)

Если t имеет метаметод __pairs, вызывает его с аргументом t и возвращает первые три результата вызова.

Иначе, возвращает три значения: функцию next, таблицу t и nil, так что конструкция for k,v in pairs(t) do body end будет перебирать все пары ключ–значение в таблице t.

См. функцию next для предострежений о модификации таблицы во время просмотра.

pcall (f [, arg1, ···])

Вызывает функцию f с переданными аргументами в защищенном режиме. Это значит, что любая ошибка внутри f не распространяется; взамен,pcall перехватывает ошибку и возвращает код статуса. Её первый результат — код статуса (логическое значение), которое равно true, если вызов успешен. В этом случае pcall также возвращает все результаты из вызова, после первого результата. В случае ошибки pcall возвращает false и сообщение об ошибке.

rawequal (v1, v2)

Проверяет, что v1 равен v2, без вызова метаметодов. Возвращает логическое значение.

rawget (table, index)

Возвращает реальное значение table[index], без вызова метаметодов. table должен быть таблицей, index может быть любым значением.

rawlen (v)

Возвращает длину объекта v, который должен быть таблицей или строкой, без вызова метаметодов. Возвращает целое.

rawset (table, index, value)

Устанавливает реальное значение table[index] равным value, без вызова метаметодов. table должен быть таблицей, index — любое значение отличное от nil и NaN, value — любое Lua значение.

Эта функция возвращает table.

select (index, ···)

Если index это число, возвращает все аргументы после аргумента номер index; негативное число индексируется с конца (-1 последний аргумент). Иначе, если index строка "#", select вернет общее количество дополнительных аргументов.

setmetatable (table, metatable)

Устанавливает метатаблицу для данной таблицы. (Вы не можете изменять метатаблицы других типов из Lua, только из C.) Если metatable = nil, удаляет метатаблицу переданной таблицы. Если оригинальная метатаблица имеет поле "__metatable", генерирует ошибку.
Эта функция возвращает table.

tonumber (e [, base])

Когда вызвана без аргумента base, tonumber пытается конвертировать аргумент в число. Если аргумент уже число или строка, которую можно преобразовать в число, то tonumber возвращает это число; иначе, возвращает nil.

Преобразование строк может выдавать в результате целые или вещественные числа, в соответствии с лексическими соглашениями Lua. (Строка может иметь начальные и конечные пробелы и знак.)

Когда вызвана с аргументом base, то аргумент e должен быть строкой, которая интерпретируется как целое в данной системе счисления. base может быть любым целым от 2 до 36, включительно. При base > 10, символ ‘A‘ (в верхнем или нижнем регистре) представляет 10, ‘B‘ представляет 11 и так далее, с ‘Z‘ представляющим 35. Если строка e не правильное число в данной системе счисления, функция возвращает nil.

tostring (v)

Получает значение любого типа и преобразует его в строку в понятном человеку формате. (Для полного контроля над преобразованием чисел используйте string.format.)

Если метатаблица v имеет поле "__tostring", то tostring вызывает соответствующее значение с v в качестве аргумента и использует результат вызова, как свой результат.

type (v)

Возвращает тип любого аргумента, представленный строкой. Возможные результаты этой функции: «nil» (строка, не значение nil), «number», «string», «boolean», «table», «function», «thread» и «userdata».

_VERSION

Глобальная переменная (не функция), которая содержит строку с текущей версией интерпретатора. Текущее значение этой переменной «Lua 5.3».

xpcall (f, msgh [, arg1, ···])

Эта функция похожа на pcall, но она устанавливает новый обработчик сообщений msgh.