Справочник API

API cs-lua предоставляет Lua-плагинам доступ к игрокам, событиям, командам, таймерам, сущностям, серверу и другим возможностям движка.

Основные возможности

Игроки

Работа с игроками: здоровье, броня, оружие, поиск и рассылка сообщений.

События

Обработка игровых событий и создание собственных событий.

Команды

Регистрация команд чата, серверной консоли и RCON.

Таймеры

Выполнение кода с задержкой или через заданные интервалы.

Сущности

Поиск и работа с сущностями игрового мира.

Сервер

Управление сервером, картой, CVar и выполнение консольных команд.

Дополнительные возможности

Эффекты

Взрывы, лучи, спрайты и другие визуальные эффекты.

Ресурсы

Прекеш звуков, моделей и других ресурсов.

База данных

Работа с SQLite и MySQL.

Хранилище

Key-value хранилище на SQLite.

HTTP

Выполнение исходящих HTTP-запросов без блокировки игрового цикла.

UI

Цвета, текст и другие возможности для работы с интерфейсом.

Плагины и доступ

Права доступа

Права, группы и иммунитет игроков.

Плагины

Метаданные, жизненный цикл и управление плагином.

Экспорты

Вызов функций и взаимодействие между плагинами.

Модули

Помимо API, cs-lua предоставляет несколько модулей, которые можно подключить через стандартный require().

Модуль	Описание
`store`	Key-value хранилище на SQLite
`datafile`	Чтение и запись файлов `data/*.lua`
`json`	Разбор и сборка JSON
`color`	Разбор цветов
`text`	Работа с длиной строк в формате клиента
`class`	Классы с наследованием

Подробнее о подключении модулей — в разделе Структура плагина.

Консольные команды

cs-lua также предоставляет несколько консольных команд для управления модулем и плагинами. Полный список доступен в консольных командах.

Документация