Данные

Хранилище

Storage хранит значения по ключу, как Map, только на диске: то, что плагин сохранил, переживает смену карты и перезапуск сервера. Это место для накопленных очков игрока, его последнего визита, настройки.

const 
visits
= new
Storage
<number>("myplugin_visits");
server
.
addEventListener
("putInServer", (
event
) => countVisit(
event
.
player
));
function countVisit(
player
: Client) {
const
count
= (
visits
.
get
(
player
.
steamId
) ?? 0) + 1; // undefined, если ключа нет
visits
.
set
(
player
.
steamId
,
count
);
console
.
log
(`${
player
.
name
}: заход номер ${
count
}`);
}
МетодЧто делает
get(key)значение под key или undefined
set(key, value)кладёт value под key, заменяя то, что там было
has(key)true, если под key есть значение
delete(key)удаляет key: true, если он был
keys() с v0.3все ключи
size с v0.3сколько в нём ключей
prune(olderThan) с v0.3удаляет то, что последний раз записывали раньше Date; сколько ключей ушло

Аргумент типа — то, что лежит в хранилище с v0.3: текст по умолчанию (new Storage("name")) или число, булево значение, объект интерфейса — new Storage<Profile>("myplugin_profiles"), — хранится как JSON.

interface Profile {
    
kills
: number;
title
: string;
} const
profiles
= new
Storage
<Profile>("myplugin_profiles");
const
mine
=
profiles
.
get
(
player
.
steamId
) ?? {
kills
: 0,
title
: "rookie" };
mine
.
kills
++;
profiles
.
set
(
player
.
steamId
,
mine
);
profiles
.
prune
(new
Date
(
Date
.
now
() - 30 * 24 * 3600 * 1000)); // месяц без изменений
Поле, добавленное позже, — необязательное
get читает значение в той форме, какая у типа сейчас, а у записи, сохранённой до того, как вы добавили поле, этого поля нет. Поле, которое вы добавляете, объявляйте необязательным и читайте со значением по умолчанию: title?: string, затем mine.title ?? "rookie". Поле класса со значением по умолчанию (title = "rookie") получает это значение.Значение, которое всё равно не читается, — нет поля, которое не то и не другое, поле другого типа, — get бросает TypeError с именем хранилища, ключом и полем, а значение остаётся на диске: Storage "myplugin_profiles", key "STEAM_0:0:1": JSON: title is missing, text was expected.

Имя — это файл хранилища: new Storage("myplugin_visits") держит данные в addons/amxmodx/data/amxts/storage/myplugin_visits.json — JSON, который может прочитать админ. Давайте каждому хранилищу своё имя, начиная с имени плагина: все плагины, открывшие одно имя, делят его. Изменение попадает на диск не позже чем через секунду — файл пишется целиком через временный — и при смене карты.

Когда у имени ещё нет файла, оно один раз берёт то, что под тем же именем хранил nvault AMX Mod X (data/vault/<name>.vault): плагин, переехавший с Pawn, сохраняет данные своих игроков.