---
# System prepended metadata

title: Руководство API (Core)

---

# Руководство API (Core)
**Core** отвечает за основное взаимодействие игрока и администраторов при помощи **тикетов**.

## Объекты
### строка
Набор символов, размер которого не превышает 64.

### текст
Набор символов, размер которого может превышать 64.

### флаг
Принимает значение `1` или `0`.

### пользователь
В CATS игрок передавался и интерпретировался как объект, в связи с чем с ним невозможно было оперировать, если он не существует на клиенте какого-то администратора. Поэтому в качестве пользователя передаётся его [SteamID](https://steamid.io/).

В случае, если пользователь не является игроком или администратором, то параметр, хранящий данное значение, будет **отсутствовать**. Реалмам следует учитывать такой случай и в качестве имени отображать что-то наподобие `Консоль`, `Сервер`, `Помощник`, `Доброград` и т.д.


## Список событий
**Событие** --- сигнал о каком-то действии, выполненном игроком, администратором или сервером.

Каждое событие по умолчанию имеет следующие параметры:
|  Параметр   | Тип                         | Комментарий               |
| ---------- | --------------------------- | ----------------- |
| **id**     | целое число                  | Генерируется при создании тикета (событие [open](#open)), в дальнейшем используется для определения, к какому тикету относится то или иное событие. Обычно равен *номеру предыдущего тикета + 1* |
| **server** | строка                      | Краткое название сервера (`dbg`, `dbg2`, `dbg22`) |
| **user**   | [пользователь](#пользователь) | Кто вызвал событие |
| **time**   | целое число                  | Время, когда было вызвано событие, в формате [Unix timestamp](https://www.epochconverter.com/) |

### open
Игрок открыл тикет, отправив первое сообщение. По мнению автора, несмотря на полную схожесть параметров событий [open](#open) и [msg](#msg), их не следует объединять в один.

| Параметр | Тип     | Комментарий               |
| -------- | ------- | ---------------------- |
| **msg**  | текст   | Первое сообщение, отправленное пользователем |

### msg
Пользователь набрал сообщение и нажал кнопку отправки.
| Параметр | Тип     | Комментарий |
| -------- | ------- | --------- |
| **msg**  | текст   | Сообщение  |

### status
Администратор принял или передал тикет.
| Параметр     | Тип    | Комментарий                                      |
| ----------- | -----  | ----------------------------------------------- |
| **value**  | флаг   | `1` -- тикет был принят<br/>`0` -- тикет был отдан |

### close
Тикет был закрыт игроком или администратором, принявшим его.