Квары
Квар — именованная настройка сервера: mp_freezetime, sv_gravity или
собственная настройка плагина. Объект Cvar читает и пишет один квар:
const freezeTime = new Cvar("mp_freezetime");
const speed = new Cvar("myplugin_speed", "250"); // создастся со значением "250", если такого квара на сервере нет
speed.addEventListener("change", (event) => {
console.log(`${event.cvar.name}: ${event.oldValue} -> ${event.value}`);
});
function startWarmup() {
freezeTime.number = 0;
console.log(`скорость ${speed.number}, текст "${speed.value}", включён: ${speed.boolean}`);
}
Как value у поля ввода, квар внутри — текст, и читать и писать его можно
тремя способами:
| Свойство | Читает | Пишет |
|---|---|---|
value | текст: "250" | текст |
number | число: 250 | число; целое пишется без дробной части ("5", а не "5.000000") |
boolean | true для всего, кроме 0 | true как 1, false как 0 |
Второй аргумент new Cvar — значение по умолчанию. Если на сервере нет квара
с таким именем, он создаётся с этим значением — так плагин добавляет свои
настройки. Без значения по умолчанию отсутствующий квар так и остаётся
отсутствующим: exists равно false, чтение даёт "", 0 и false, а
запись ничего не делает.
Создавайте Cvar один раз, в начале файла, и пользуйтесь им оттуда. Cvar,
созданный в начале файла, находит свой квар, когда сервер загрузит все
плагины, поэтому к моменту, когда ваш код его читает, квары игры и других
плагинов уже на месте.
Как узнать об изменении
addEventListener("change", listener) вызывает обработчик при каждом
изменении — из консоли, из конфига, через amx_cvar, из другого плагина или
из этого — один раз, после изменения, с event.cvar, event.oldValue и
event.value (оба — текст). То же значение, заданное снова, — не изменение.
removeEventListener("change", listener) с той же функцией его снимает.
hook_cvar_change плагина на Pawn слышит изменение раньше обработчиков. На
сервере без ReHLDS, в gamedata AMX Mod X которого нет сигнатуры функции
движка Cvar_DirectSet, изменение слышно в следующем кадре после него.Плагин, который читает настройки один раз, может делать это в событии
"configsExecuted", когда сервер уже выполнил свои конфиги
(Плагин):
const reward = new Cvar("myplugin_reward", "300");
let rewardMoney = 0;
server.addEventListener("configsExecuted", () => {
rewardMoney = reward.number;
});
Для настроек сложнее пары чисел — списков, вложенных разделов, значений под каждую карту — чаще удобнее файл конфига (Конфиги).
Секреты и настройки сервера: env() с v0.3
Токену, паролю или ключу в URL не место в коде плагина: всё, что
скомпилировано в .aot, из него можно достать. Положите их в
addons/amxts/.env на сервере и читайте через env():
# addons/amxts/.env
MYPLUGIN_TOKEN=abc123
MYPLUGIN_MAX_RECORDS=500
MYPLUGIN_DEBUG=on
const token = env("MYPLUGIN_TOKEN"); // текст, обязательная
const maxRecords = env("MYPLUGIN_MAX_RECORDS", 100); // число, 100, если её нет
const debug = env("MYPLUGIN_DEBUG", false); // переключатель
const mirror = env("MYPLUGIN_MIRROR", "https://example.com/maps"); // текст со значением по умолчанию
Все плагины сервера читают один и тот же файл. Строка — ИМЯ=значение, #
начинает комментарий, значение в кавычках берётся как есть, вместе с # и
пробелами. Переменная из окружения процесса сервера — её задаёт игровая панель
или Docker — перекрывает строку файла с тем же именем.
Значение по умолчанию задаёт, чем будет значение:
| Вызов | Даёт | Значение в .env |
|---|---|---|
env("NAME") | текст | любое; переменная обязательна |
env("NAME", "text") | текст | любое |
env("NAME", 100) | число | десятичное число: 500, -1.5, 2e3 |
env("NAME", false) | true или false | 1/0, true/false, yes/no, on/off, в любом регистре |
Имя и значение по умолчанию пишутся прямо в вызове — env(name) или
env("NAME", limit) не собираются: сборка читает из вызова, что нужно каждому
плагину. Плагин не запускается, пока переменной, которую он читает без значения
по умолчанию, нет нигде или пока значение не того вида, что значение по
умолчанию. Консоль говорит об этом одной строкой:
[amxts] myplugin needs MYPLUGIN_TOKEN in addons/amxts/.env
[amxts] myplugin needs MYPLUGIN_MAX_RECORDS as a number in addons/amxts/.env
а amxts_plugins показывает плагин как refused с той же причиной. Исправьте
строку в .env — и amxts_reload myplugin перечитает файл и запустит плагин.
amxts dev и amxts build --deploy предупреждают, если в .env сервера нет
того, что нужно плагину; сам .env они никогда не копируют.
.env — файл в папке игры: его может прочитать любой, у кого есть FTP-доступ к
серверу. Ни одна консольная команда не печатает значение, поэтому через rcon
его не узнать. Каждый плагин на сервере может прочитать любую переменную.Флаги
Часть данных игры — набор флагов «включено/выключено»: какие кнопки держит игрок, какие части HUD скрыты, стоит ли сущность на земле. В плагине такой набор — массив имён:
Сообщения
Сервер говорит каждому клиенту, что рисовать и играть, сообщениями: строка чата, значок HUD, часы раунда, сообщение об убийстве. Плагин слышит сообщение до того, как оно ушло, читает его, меняет или останавливает: