Игроки: команда, действия, списки
Player — это игрок на сервере. Его даёт событие или команда, к которой он
относится (event.player, player в обработчике команды), а
server.players перечисляет всех. Игровые данные игрока — gravity, origin,
hideHud и остальные — это свойства, они описаны на странице
Игроки и сущности. Эта страница — о том, что с игроком можно
делать: найти, перевести в команду, выдать оружие, показать текст и
поделиться его состоянием с другими плагинами.
server.addCommand("/rearm", rearm, { access: "slay" });
function rearm() {
for (const player of server.players.filter(other => other.isAlive && other.team === "CT")) {
player.removeAllItems();
player.give("weapon_knife");
player.give("weapon_m4a1");
player.setAmmo("weapon_m4a1", 90);
player.showHud("Перевооружены!", { color: [0, 200, 0], hold: 2 });
}
}
Список игроков с v0.2
for (const player of server.players) console.log(player.name); // все
const aliveCts = server.players.filter(player => player.isAlive && player.team === "CT");
const people = server.players.filter(player => !player.isBot); // без ботов
const bots = server.players.filter(player => player.isBot);
const dead = server.players.filter(player => !player.isAlive);
server.players — все подключённые, и читается заново при каждом обращении:
держите список в переменной, только пока игроки в нём не могут измениться.
Это массив, поэтому часть списка — filter, а один игрок — find, по
свойствам самого игрока: isAlive, isBot, team ("TERRORIST",
"CT", "SPECTATOR" или "UNASSIGNED"). HLTV-прокси в списке не бывает
никогда.
Команда
if (player.team == "CT") console.log("спецназовец");
player.team = "TERRORIST";
player.team — это "TERRORIST", "CT", "SPECTATOR" или "UNASSIGNED"
(тип Team), и сразу после смены команды он уже верный. Присваивание
переводит игрока: модель меняется на модель новой команды, таблица счёта
показывает новую команду. Условия победы в раунде при этом не проверяются —
если перевод должен закончить раунд, закончите его сами через
game.endRound (События игры).
server.addEventListener("putInServer", async (event) => {
await sleep(200, { signal: event.player.signal }); // игра ещё ставит его в мир
event.player.joinTeam("CT"); // false, если игра отказала
});
player.joinTeam(team) вводит игрока в сторону так, как игра вводит того, кто
выбрал её в меню команд, а внешность выбирается за него. У только что
пришедшего игрока стороны нет, и в игре его ещё нет; присваивание
player.team даёт ему сторону, а joinTeam ещё и вводит его в игру, так что
он может появиться. Живой игрок, отправленный в зрители, тихо умирает: без
смерти и без фрага.
mp_limitteamsНа сервере без ReGameDLL игра отказывает в стороне, которую
mp_limitteams
перегрузил бы, как и в меню команд, и мёртвому игроку, который уже сменил
сторону в этом раунде; joinTeam возвращает false. На ReGameDLL вызов эти
проверки пропускает и ставит игрока на ту сторону, которую ему дали.Голос
player.muted = true; // в голосовом чате его никто не слышит
if (player.muted) console.log(`${player.name} без голоса`);
player.muted = false;
player.heardByEveryone = true; // его слышат обе стороны
player.hearsEveryone = true; // он слышит обе стороны — например, зритель
Кто кого слышит, игра решает по сторонам и sv_alltalk; эти три свойства
меняют это для одного игрока, каждое само по себе. muted работает и с
включённым sv_alltalk, и с выключенным и сильнее heardByEveryone. Кто кого
слышит среди игроков на сторонах, можно решать и в каждом случае отдельно —
событием игры canPlayerHearPlayer (События игры).
Квары его игры
server.addCommand("/fps", async ({ player }) => {
const limit = await player.queryCvar("fps_max"); // "100" или null
player.print(`fps_max ${limit ?? "неизвестно"}`);
});
player.queryCvar(name) спрашивает у игры игрока один из её кваров и отдаёт
промис ответа: значение текстом или null, если такого квара в его игре нет
или она его не называет. Ответ — то, что говорит его игра, заявление, которое
чит может подменить. У бота игры нет, и он сразу отвечает null. Если игрок
уходит раньше ответа, промис отклоняется с "AbortError", а его асинхронная
команда тихо останавливается (асинхронность).
Как его игра подтвердила, кто он с v0.2
server.addCommand("/game", ({ player }) => {
if (player.authType === "steam") player.print("Ваша игра из Steam");
else player.print(`Ваша игра: ${player.authType}, протокол ${player.protocol}`); // "revEmu2013, протокол 48"
});
Reunion — плагин ReHLDS, который пускает на сервер игроков без Steam. С ним
player.authType говорит, как игра игрока подтвердила, кто он (тип
AuthType): "steam" — игра из Steam; у игры без Steam — эмулятор, которым
она себя подтвердила: "steamEmu", "revEmu", "revEmu2013",
"oldRevEmu", "sc2009", "avsmp", "sxei", "sse3"; "dproto";
"hltv" — HLTV-прокси. player.protocol — сетевой протокол его игры: 48
у нынешней игры, 47 у старой, которую пускает Reunion. player.authKey —
ключ, которым его игра себя подтвердила, из него сделан его SteamID
(player.steamId): "STEAM_..." или "VALVE_...", как скажут настройки
Reunion на сервере.
Всё это знает только Reunion: amxts спрашивает его API, которое Reunion даёт другим плагинам через ReHLDS. На сервере без Reunion или без ReHLDS
authType — "unknown", protocol — 0, authKey — "".Действия
player.give("weapon_flashbang"); // или "item_kevlar", "item_assaultsuit", "item_thighpack"
player.setAmmo("weapon_flashbang", 2); // патроны к нему с собой
player.getAmmo("weapon_flashbang"); // 2
player.switchWeapon("weapon_knife"); // false, если ножа нет
player.removeAllItems(); // всё оружие
player.removeItems("primary"); // оружие одного слота вместе с патронами
player.dropItem("weapon_c4"); // на землю; dropItem() - то, что в руках
player.slap(5); // толчок и 5 HP
player.resetMaxSpeed(); // скорость снова по оружию
player.respawn();
player.kill(); // kill({ keepFrags: true }) - без штрафа во фрагах
player.command("stop"); // в его собственной консоли, как будто он набрал сам
player.deaths = 0; // таблица счёта тоже обновится
| Метод | Что делает |
|---|---|
give(item) | выдаёт оружие или предмет; false, если игра не выдала. Имя из конфига передаётся как есть — о таком, для которого в игре нет предмета, один раз скажет консоль |
setAmmo(weapon, amount) | задаёт патроны, которые игрок носит к своему оружию, помимо обоймы |
getAmmo(weapon) | патроны, которые игрок носит к своему оружию; для гранаты — сколько их; 0 для оружия, которого у него нет |
switchWeapon(weapon) | берёт в руки оружие, которое у него есть; false, если такого нет |
removeAllItems(options?) | забирает всё оружие; костюм — броня и HUD — остаётся, если не указано { suit: true } |
removeItems(slot) с v0.3 | забирает оружие одного слота — "primary", "secondary", "knife", "grenades" или "c4" — вместе с патронами; false, если что-то осталось |
dropItem(weapon?) с v0.3 | выбрасывает оружие, которое он несёт, как drop игры, — без имени то, что в руках; оружие, теперь в коробке на земле, или null, если такого нет или игра его не отдала (нож) |
slap(damage?) с v0.3 | шлепок админа: толчок в случайную сторону, рывок взгляда, звук боли, damage, отнятый от здоровья, — последнее здоровье убивает |
resetMaxSpeed() | возвращает скорость, которую позволяет оружие в руках, — например, после замедления |
respawn() | возрождает в текущем раунде, на точке, которую выберет игра |
kill(options?) | убивает живого игрока, как команда kill, и бота тоже: игра записывает самоубийство - одну смерть, минус фраг, сообщение о смерти без оружия, - а { keepFrags: true } возвращает фраг; мёртвому и зрителю ничего не делает |
command(text) | выполняет команду в консоли игрока: её выполняет его игра, а не сервер |
view с v0.3 | сущность, через которую он видит мир, — player.view = camera, null — его собственные глаза |
Имена оружия — тип WeaponName ("weapon_knife", "weapon_awp", …), а
предметы, которые принимает give, — ItemName; редактор их подсказывает, а
методы, принимающие WeaponName, не пропускают опечатку. У оружия, которое игрок несёт, имя — weapon.classname
(оружие): other.give(weapon.classname).
name, health, armor, frags и deaths — свойства: их можно читать, а
health, armor, frags и deaths — ещё и присваивать. health, равный
0 или меньше, убивает игрока.
Действия работают на любом сервере, и amxts выполняет их сам: на ReGameDLL — его собственными функциями, так что обработчики всех плагинов слышат их так же, как действия игры; на обычном HLDS — функциями игры и движка. Ни ReAPI, ни другой модуль не нужен, и плагин пишется одинаково.
Его собственное движение с v0.3.1
player.movement.airAccelerate = 100; // стрейфы легко набирают скорость — только у него
player.movement.friction = 2; // он скользит дальше
player.movement.airAccelerate; // 100; для незаданной — sv_airaccelerate сервера
player.movement.reset(); // снова серверные
player.movement — собственные переменные движения игрока: сервер двигает
его по ним, и его игра предсказывает по ним его движение, так что он
движется плавно. Каждая равна квару сервера, пока её не задали:
| Поле | Квар сервера |
|---|---|
accelerate | sv_accelerate |
airAccelerate | sv_airaccelerate |
waterAccelerate | sv_wateraccelerate |
friction | sv_friction |
edgeFriction | edgefriction |
waterFriction | sv_waterfriction |
stopSpeed | sv_stopspeed |
stepSize | sv_stepsize |
Гравитация и предельная скорость у игрока и так свои: player.gravity и
player.maxSpeed.
Каждую карту и каждое подключение игрок начинает с переменными движения сервера: задавайте его собственные снова в обработчике
putInServer.Попадание и прыжок ненадолго замедляют игрока: player.slowdown —
замедление от попадания, множитель его скорости (1 — нет замедления), а
player.jumpSlowdown с v0.3.1 — от прыжка, в оставшихся
миллисекундах (0 — нет). Оба сразу возвращают ему полную скорость:
player.slowdown = 1;
player.jumpSlowdown = 0;
Проход сквозь друг друга с v0.3.3
Игроки проходят друг сквозь друга с модулем
semiclip: плагин говорит, кто сквозь кого
проходит, правилом над двумя игроками, а проект задаёт в amxts.config.ts,
как партнёр выглядит вблизи, пролетает ли сквозь него граната и стоит ли
игрок сверху у него на голове с v0.3.5. Плагин может выключить стояние
на голове, пока работает: semiclip.standOnHead = false.
semiclip.rule = (player, target) => player.team == target.team;
Двое, которые проходят друг сквозь друга, — партнёры — проходят сквозь друг
друга, и игра каждого это предсказывает. Пуля, свет флешки и взрыв
останавливаются на партнёре, как на любом, и союзник от пули не страдает,
если огонь по своим выключен. Обработчик entityState для игроков
выполняется после вида, который рисует модуль, и может изменить
нарисованное; event.solid говорит, приходит ли игрок твёрдым.
Они остаются застрявшими друг в друге, пока один не выйдет: удаляйте пару, когда они порознь, или передвиньте одного из них.
Работают оба: пара проходит, если это разрешает любой из них, а для пар, которые пропускает ReSemiclip, рисуется его внешний вид. Консоль один раз об этом скажет.
Его модель с v0.3
player.model = "vip"; // остаётся при возрождениях и смене команды
player.model; // "vip"
server.precache("models/player/santa/santa.mdl");
player.setModel("santa", { hitboxes: true }); // и хитбоксы самой модели
player.resetModel(); // та, что выбрала для него игра
player.model — модель, которую он носит, по имени, которое знает его игра:
одна из моделей игры ("gign", "leet") или своя модель сервера, файл
models/player/<name>/<name>.mdl, который игроки скачивают, если он
закэширован. Заданная, она остаётся до resetModel(): amxts возвращает её,
когда игра надевает на него модель команды. modelName — модель, которую
выбрала игра; её и возвращает resetModel().
Модель другой формы, чем у игры, получает попадания там, где они были бы у модели игры.
setModel(name, { hitboxes: true }) берёт хитбоксы самой модели;
модель для этого должна быть закэширована заранее.Что сервер знает о нём с v0.3
player.info.get("cl_righthand"); // "1": ключ настроек, которые прислала его игра
player.info.set("_vgui_menus", "0"); // сервер и его игра принимают новое значение
player.userId; // 12: номер, которым его называют команды сервера, #12
player.ping; // 45, в миллисекундах
player.loss; // 0, доля потерянных пакетов в процентах
player.connectedSeconds; // 312
player.isHltv; // true для прокси HLTV
player.country; // "Germany" или null
player.countryCode; // "DE" или null
player.silentSteps = true; // шаги беззвучны, пока он не появится заново
player.info — его userinfo: настройки, которые его игра сообщает серверу,
каждый ключ — текст: "model", "cl_righthand", "_vgui_menus", "lang".
Ключ, которого игра не прислала, читается как "".
Что уходит каждому клиенту с v0.3.5
Движок отправляет каждому клиенту userinfo игрока, когда тот заходит и когда
userinfo меняется, и игровое событие sendUserInfo слышит его по пути, по
разу на клиента. event.info — то, что уходит этому клиенту: запись ключа
меняет то, что он видит у игрока, — имя в таблице счёта и в сообщениях об
убийствах, модель, — и больше ничего. У самого игрока, у игры и у остальных
клиентов остаётся настоящий. event.receiver — клиент, которому он уходит.
player.info.resend() сразу отправляет userinfo игрока всем клиентам.
// Сообщение об убийстве называет убийцу «Killer + Assister».
let shown: Player | null = null;
let shownName = "";
game.addEventListener("sendDeathMessage", (event) => {
const killer = event.killer;
const assister = server.players.find((each) => each.id == event.assister.id);
if (!assister) return;
shown = killer;
shownName = `${killer.name} + ${assister.name}`;
killer.info.resend();
setTimeout(() => { // в следующем кадре, когда сообщение уже ушло
shown = null;
killer.info.resend();
});
});
game.addEventListener("sendUserInfo", (event) => {
if (event.player == shown) event.info.set("name", shownName);
});
Показываемое имя пишется в event.info, а не в player.info: новое имя там —
собственное имя игрока, и игра переименует его и сообщит об этом в чат.
Боту userinfo не отправляется, поэтому он никогда не бывает
receiver
события. Когда игрок меняет свой userinfo, движок может отправить его всем
клиентам сразу: тогда event.receiver — null, и то, что записал
слушатель, уходит всем. resend() отправляет каждому клиенту отдельно.На чистом HLDS amxts перехватывает собственную функцию движка: на Linux, а на Windows — в сборке HLDS, которую он знает. В остальных случаях консоль пишет об этом, когда добавляется первый слушатель,
sendUserInfo не
приходит, а resend() ничего не отправляет.player.country и player.countryCode берутся из базы GeoIP, которую читает
собственный модуль AMX Mod X geoip, — GeoLite2-Country.mmdb в папке data
AMX Mod X; amxts читает её сам, загружать модуль не нужно.
На сервере без
GeoLite2-Country.mmdb (или GeoLite2-City.mmdb) в папке data
AMX Mod X стран нет: оба читаются как null, и консоль один раз об этом
говорит. Нет их и у адреса локальной сети, и у бота.Фейковые клиенты с v0.2
Фейковый клиент — бот — это игрок, которого ведёт сам сервер: он занимает
слот, есть в server.players и играет по правилам игры, но игры за ним нет.
server.addBot(name) добавляет такого:
const bot = server.addBot("Dummy"); // null, если свободного слота нет
if (bot) {
bot.joinTeam("CT");
bot.respawn();
}
Он приходит, как любой игрок, — для него срабатывают "connect" и
"putInServer", — bot.isBot равно true, а bot.kick() убирает его, с
"disconnected".
Своего разума у бота нет: он стоит, где появился, и ничего не делает, пока
плагин его не двинет. bot.move(options) — это один кадр его клавиш и мыши,
поэтому его вызывают каждый кадр, в событии "frame", пока бот должен
двигаться:
server.addEventListener("frame", () => {
bot?.move({ forward: 250, buttons: ["jump"], angles: [0, 90, 0] });
});
| Параметр | Что это |
|---|---|
forward | скорость вперёд, единиц в секунду; назад, если отрицательная (250 — бег с ножом) |
side | вправо; влево, если отрицательная |
up | вверх, в воде и на лестнице; вниз, если отрицательная |
buttons | кнопки, зажатые на время шага: "attack", "attack2", "jump", "duck", "use", "reload", … (тип Button) |
angles | куда он смотрит, [pitch, yaw, roll] или Vector; если не задано — куда смотрит сейчас |
msec | сколько длится шаг, от 1 до 255 миллисекунд; если не задано — время кадра |
move для игрока, который не бот, бросает Error: плагин двигает только
своих ботов.
bot.command(text) с v0.3 отправляет команду от имени бота, так же
как игра игрока отправляет то, что он набрал: её слышат Pawn-плагины сервера,
addCommand и событие "command" каждого плагина amxts и сама игра, в этом
порядке.
bot.command("say /hp"); // команда чата
bot.command("jointeam 2"); // команда самой игры
Строку разбирает и передаёт дальше движок, как у игрока, поэтому её слышат все плагины. HLDS от Valve на Windows такой возможности не даёт: там игра получает команду так, как её даёт
engclient_cmd AMX Mod X, и другие
плагины Metamod — среди них AMX Mod X — её не слышат.addBot даёт тело, а не игрока: сам он не ходит, не целится, не стреляет и
не покупает. Всё, что он делает, — это вызовы move плагина, кадр за кадром.
Шаг, вызванный реже — из таймера раз в 0,1 секунды, — двигает его только на
свой msec, а не до следующего вызова.Есть ли модуль на сервере
if (!hasModule("reapi")) console.warn("myplugin: get_member нужен ReAPI");
hasModule возвращает true, если на сервере работает этот модуль AMX Mod X:
"reapi", "cstrike", "fun", "hamsandwich", "engine" или
"fakemeta". Спрашивайте его перед нативом, который есть только в одном
модуле.
HUD
player.showHud("-35 HP");
player.showHud("Раунд 3", { color: [255, 40, 40], x: 0.02, y: 0.88, hold: 2 });
player.showHud("печатается по буквам", { effect: "typewriter", channel: 2 });
player.showHud("ТЕРРОРИСТЫ ПОБЕДИЛИ", { large: true, y: 0.3, hold: 5 }); // крупные буквы
server.showHud("Для всех", { y: 0.6 });
HUD-сообщение — это текст на экране вне чата. Любую настройку можно не писать:
| Настройка | По умолчанию | Значение |
|---|---|---|
color | [200, 100, 0] | красный, зелёный, синий, от 0 до 255 |
x, y | -1, 0.35 | позиция, от 0 до 1 от левого верхнего угла; -1 — по центру |
hold | 12 | сколько секунд держится на экране |
effect | "fade" | "fade", "flicker" или "typewriter" (по буквам) |
fadeIn, fadeOut | 0.1, 0.2 | секунды на появление и на исчезновение |
effectTime | 6 | сколько секунд идут эффекты "flicker" и "typewriter" |
channel | -1 | канал, от 1 до 4; -1 берёт свободный. Новое сообщение на канале заменяет старое |
large | false | крупные буквы — для итога или заголовка; каналов у них нет |
HUD-сообщение amxts отправляет сам с v0.3, по четырём каналам игрока:
HudLine держит свой канал, пока его никто не занял, а любое другое сообщение
берёт канал, где сообщение уже закончилось, а если такого нет — канал
наименее важной строки, которая закончится раньше
других. Учёт каналов
общий для всех плагинов amxts; сообщения плагинов на Pawn учитывает сам AMX
Mod X, поэтому они могут попасть на один канал с сообщениями amxts.
Строка, которая обновляется, — HudLine
const countdown = new HudLine();
function tick(player: Player, left: number) {
countdown.show(player, `Бомба: ${left}`, { color: [255, 50, 50], hold: 1.1 });
}
HudLine — одно место на экране: каждый show заменяет то, что оно
показывало, а обычный showHud занял бы другой канал, и прошлая цифра
угасала бы под новой. countdown.clear(player) убирает строку с экрана
одного игрока раньше времени, countdown.clearAll() — у всех, а
countdown.showAll(text, options) с v0.3 показывает текст всем на этой
строке.
Какая строка уступает с v0.3.1
const speed = new HudLine({ priority: 1 }); // перерисовывается каждый кадр, всегда на экране
const notice = new HudLine(); // приоритет 0
priority строки — число, по умолчанию 0. Пока на всех четырёх каналах
игрока сообщения ещё видны, новое сообщение занимает канал строки с меньшим
или таким же приоритетом — из них ту, что закончится раньше, — а строка с
большим приоритетом свой канал сохраняет. Сообщение без строки (showHud)
считается приоритетом 0; сообщение с channel занимает этот канал, что бы
на нём ни было.
Эффекты экрана — player.screen
player.screen.fade({ color: [200, 0, 0, 100], duration: 0.5 }); // красная вспышка, которая проходит
player.screen.fade({ color: [0, 0, 0, 255], duration: 0.1, hold: 1, stay: true }); // чёрный экран, и он остаётся
player.screen.fade({ color: [0, 0, 0, 0], duration: 0.2 }); // снова ясно
player.screen.shake({ amplitude: 8, duration: 1, frequency: 5 });
player.screen.statusIcon("dmg_cold", "show", [0, 200, 255]); // "hide", "show", "flash"
player.screen.roundTime(90); // часы раунда, в секундах
player.screen.hideHud(["money", "timer"]); // сразу
player.screen.crosshair(false);
player.screen.flashlight(false); // значок фонарика
player.screen.progressBar(5); // полоса заполнится за 5 секунд; 0 её убирает
player.screen.progressBar(4, { startPercent: 50 }); // наполовину полна, заполнится за 2 секунды
player.screen.hint("Заложи бомбу"); // рамка подсказки, как у самой игры
player.screen.hint(text) с v0.3 показывает подсказку в рамке вверху
экрана, как игра показывает свои.
player.screen.lightStyle(style) с v0.3 ставит свет, который видит
только он, от "a" — самого тёмного — до "z" — самого яркого, как
server.lightStyle ставит его всем: ночное зрение —
player.screen.lightStyle("z"), а "" возвращает ему свет сервера.
Следующий
lightStyle сервера и следующая карта доходят до всех игроков, и
его собственный свет пропадает. Переподключившийся игрок видит свет сервера.Сообщение дня с v0.3
player.showMotd("https://my-server.com/rules", "Правила"); // страница под заголовком «Правила»
player.showMotd("<h1>Добро пожаловать</h1>"); // HTML под именем сервера
player.showMotd(text, title?) открывает окно «сообщения дня» с текстом, HTML
или адресом страницы; заголовок — имя сервера, если не задан. Текст файла
сначала читается через readFileSync из @amxts/core/fs.
Слушатели "motd" плагинов это окно не слышат, как
register_message в AMX Mod X не слышит show_motd: слушатель, который
придерживает MOTD самой игры, окно плагина не трогает.
То, что один игрок видит поверх мира. Время — в секундах.
Обработчик сообщений слышит то, что шлёт player.screen,
как слышит сообщения игры.
Настройка fade | По умолчанию | Значение |
|---|---|---|
color | [0, 0, 0, 255] | красный, зелёный, синий и непрозрачность, от 0 до 255 |
duration | 1 | сколько секунд идёт переход |
hold | 0 | сколько секунд держится полный цвет |
direction | "in" | "in" — от цвета к ясной картинке, "out" — от ясной картинки к цвету |
stay | false | цвет остаётся до следующего fade |
modulate | false | подкрашивает картинку, а не закрашивает её |
Переход или удержание дольше 16 секунд обрезается до 16.
shake:amplitude— насколько сильно трясёт, до16(по умолчанию4);durationв секундах (1);frequency— толчков в секунду (5).statusIcon(sprite, state, color): спрайт из игровогоsprites/hud.txt("dmg_cold","buyzone","c4", …) — показан, мигает или скрыт.roundTime(seconds): часы раунда вверху его HUD.hideHud(parts): сразу скрывает эти части его HUD. Свойствоplayer.hideHud(Флаги) делает то же со следующего кадра игры.crosshair(shown): собственный прицел игры.flashlight(on, battery?): значок фонарика и заряд батареи в процентах.progressBar(seconds, { startPercent }): полоса посреди его экрана, заполненная черезsecondsсекунд;0её убирает. СstartPercentс v0.2 она начинается заполненной настолько и заполняет остатокseconds: при50— за половину.
Общие поля игрока
Плагины могут добавлять в Player поля друг для друга: одно значение на
игрока, которое читают и пишут все плагины сервера — и на TypeScript, и на
Pawn. Так один плагин сообщает остальным, что игрок защищён после появления,
заморожен или получил бонус.
Плагин, которому принадлежат поля, объявляет их в своём маленьком файле, в папке внутри папки плагинов:
// plugins/myplugin/player.ts
import "@amxts/core";
declare module "@amxts/core" {
interface Player {
spawnProtected: boolean;
kills: number;
bonus: number;
tag: string;
glow: {
enabled: true | false | "default";
seenBy: Player[];
};
}
}
Каждый плагин, который ими пользуется, — и сам владелец тоже — импортирует этот файл, и поля становятся свойствами каждого игрока:
// plugins/shop.ts
import "~/myplugin/player";
function onKill(killer: Player, victim: Player) {
if (victim.spawnProtected) return;
killer.kills = killer.kills + 1;
killer.tag = "охотник";
killer.glow.enabled = true; // один член, записывается сразу
killer.glow.seenBy.push(victim); // push записывает обратно
killer.glow = { enabled: "default", seenBy: [] };
}
Файл в папке внутри папки плагинов — не отдельный плагин, а код, который
плагины импортируют по его пути после ~/.
- Типы. Поле —
boolean,number,string, юнион строковых литералов ("red" | "blue", аtrue | false | "default"— одно значение: да, нет или слово),Player[]или объект из них. Необязательных полей не бывает, и члены объекта — не объекты. - Поле, в которое ещё не писали, читается как
false,0,""или[], а юнион — как его первый строковый литерал (выше это"default"). - Поле-объект пишется прямо в объявлении, как
glowвыше, или интерфейсом из того же файла.player.glow.enabled = trueсразу записывает этот член; присваивание всего объекта записывает все члены. Player[]— массив, чейpushзаписывает обратно, как список флагов: чтобы убрать игрока, присвойте отфильтрованный массив.includesиindexOfнаходят игрока по его номеру. Ушедший с сервера игрок убирается из списков у всех.- Проверяется. Опечатка в поле (
player.gost) или значение не того типа — ошибка и в редакторе, и в сборке. Так же и одно поле, объявленное с двумя типами, и поле с именем, которое уPlayerуже есть (solid,health): дайте ему другое имя. - Только то, что плагин импортирует. Сборка знает поля файлов, которые
плагин импортирует, а редактор — всех файлов папки плагинов. Если редактор
поле принимает, а сборка говорит, что его нет, не хватает
import "~/myplugin/player". - Когда сбрасываются. Поля игрока очищаются, когда он уходит, — после
того как отработают обработчики
"disconnected"всех плагинов, так что обработчик ещё может их прочитать. Поля всех игроков очищаются при смене карты.amxts_reloadих сохраняет.
Как узнать об изменении
Когда у игрока меняется поле, сервер поднимает событие "playerChange".
Каждая запись, которая меняет значение, — любого плагина, на TypeScript или
Pawn, — сразу доходит до всех плагинов, которые слушают это поле. Какое
именно, говорит field в третьем аргументе:
import "~/myplugin/player";
server.addEventListener("playerChange", (event) => {
event.player.print(event.value ? "Вы под защитой" : "Защита после появления закончилась");
}, { field: "spawnProtected" });
event.value и event.previous — значение поля после изменения и до него,
типа этого поля: здесь boolean, для glow — объект. Плагин, который
слушает spawnProtected, не вызывается, когда меняется kills. Поле
пишется явно, как и имя события, и сборка проверяет, что это поле, которое
плагин импортирует.
Без field слышно любое поле, а какое — говорит event.field; значение
читается у игрока:
server.addEventListener("playerChange", (event) => {
console.log(`${event.player.name}: ${event.field} changed`);
});
Обработчик, написанный отдельной функцией, принимает событие своего поля:
server.addEventListener("playerChange", onProtection, { field: "spawnProtected" });
function onProtection(event: PlayerChangeEvent<"spawnProtected">) {
event.player.renderMode = event.value ? "additive" : "normal";
}
- Поле-объект меняется по одному члену, и
event.field— имя члена через точку,"glow.enabled".{ field: "glow.enabled" }слушает этот член;{ field: "glow" }— каждый из них, и вevent.valueвесь объект. Присваивание всего объекта — по изменению на каждый член, чьё значение другое. Player[]меняется, когда меняется список:pushили присвоенный список.- Не изменение: запись значения, которое у поля уже есть; уход игрока —
его поля и его место в списках других уходят без события, для этого есть
"disconnected"; смена карты. - Сразу. Обработчик выполняется внутри записи, до следующей строки плагина, который писал. Обработчик, который пишет поле, снова поднимает событие — для этого поля.
Из Pawn
Плагин на Pawn читает и пишет те же поля через amxts.inc.
amxts build --deploy и amxts dev кладут его в
addons/amxmodx/scripting/include сервера. Ключ — имя поля, как его
объявляет TypeScript:
#include <amxts>
if (amxts_get_player_data(id, "spawnProtected")) { ... }
amxts_set_player_data(id, "spawnProtected", 1);
new Float:bonus = amxts_get_player_data_float(id, "bonus");
amxts_set_player_data_float(id, "bonus", 1.5);
new tag[32];
amxts_get_player_data_string(id, "tag", tag, charsmax(tag));
amxts_set_player_data_string(id, "tag", "VIP");
// член поля-объекта: его ключ через точку
new enabled[16];
amxts_get_player_data_string(id, "glow.enabled", enabled, charsmax(enabled));
amxts_set_player_data_string(id, "glow.enabled", "true");
| Натив | Что делает |
|---|---|
amxts_get_player_data(id, const key[]) | числовое поле, целым; логическое — 1 или 0 |
amxts_set_player_data(id, const key[], value) | записывает числовое или логическое поле |
Float:amxts_get_player_data_float(id, const key[]) | числовое поле как Float |
amxts_set_player_data_float(id, const key[], Float:value) | записывает числовое поле |
amxts_get_player_data_string(id, const key[], out[], len) | текстовое поле; возвращает число записанных байт, обрезает перед буквой, которая не влезла |
amxts_set_player_data_string(id, const key[], const value[]) | записывает текстовое поле |
Поле, прочитанное не тем видом (текстовое через amxts_get_player_data),
читается как 0 или "". Юнион литералов — текст: true | false | "default" — это "true", "false" или "default", а пока в поле не
писали — "" (TypeScript читает это как первый литерал, "default").
Player[] — тоже текст, номера через запятую: "3,5".
Игроки и сущности
Всё в игровом мире — сущности: игроки, оружие, гранаты, двери, бомба. В плагине сущность — это объект, а её данные — свойства, которые читаются и присваиваются:
Эффекты
Временный эффект — то, что игра рисует на мгновение и забывает: луч, ударная волна, взрыв, искры, свет, кровь. Каждый эффект — функция effects, её настройки — аргументы эффекта, а второй аргумент говорит, кто его видит.